openapi: 3.0.1 info: title: Trust Protection Foundation WebSDK description: "\r\n# Introduction\r\nThe Trust Protection Foundation Web SDK is a subset of REST APIs that allow you to:\r\ \n * Automate certificate management\r\n * Integrate with DevOps processes\r\n * Discover machine identities\r\n *\ \ Extract data to integrate with data warehouses\r\n * Perform bulk actions\r\n * Set up and administer Trust Protection\ \ Foundation\r\n * Onboard teams\r\n * Create custom, automated business logic and flows between internal systems\r\n\ \r\nAll these use cases can be accomplished using the Trust Protection Foundation REST API. Most Web SDK calls require\ \ you to pass a bearer token in the header.\r\n\r\n[Getting started](https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/cco-sdk-GettingStarted.php)\ \ provides information about how to setup the Web SDK. This section includes several examples of the most \r\ncommon integration\ \ tasks. If you are new to developing on the CyberArk Trust Protection Foundation, you should begin here.\r\n\r\n\n\n\ > ℹ️ **Looking for the legacy WebSDK Developer's Guide?** [View the 26.1 legacy WebSDK Developer's Guide](../26.1/TopNav/Content/SDK/WebSDK/c-sdk-AboutThisGuide.php).\n\ \n# Web SDK best practices\r\nWe recommend the following best practices to improve the capability of the Web SDK:\r\n\r\ \n * If you are implementing our APIs for the first time, be sure to follow the setup details in Getting started with\ \ automation.\r\n * Review and grant the API caller the necessary permissions that match your API calls. You can use\ \ the API descriptions in \r\nthis guide to refine caller permissions. \r\n * Whenever you get an unexpected result,\ \ carefully check the API call and JSON payload. Unless otherwise specified:\r\n * API method names evaluate as case\ \ insensitive.\r\n * Parameter names and values evaluate as case sensitive.\r\n * Extra parameters may be ignored.\r\ \n * Invalid syntax, data, or parameters generate errors.\r\n * Apply the same naming standard whenever you create\ \ any new object.\r\n * Adopt a standard convention for avoiding device and certificate name collisions. Collisions can\ \ occur when the name you define already exists in a CyberArk product. You can use the same prefix or suffix, and then\ \ add something unique to the name. Suppose you are defining an object for a company called SW Banking, you could prepend\ \ SW to the start of the name. For example, SWDeviceObject.\r\n * Assign the credentials to a Policy folder that contains\ \ multiple devices. The policy credentials allow multiple devices to use the same credential.\r\n * Reuse Credential\ \ objects wherever standardization is possible to avoid creating extraneous objects.\r\n * To view API changes in the\ \ UI, be sure to refresh the contents of the page.\r\n * Use the event log to audit and troubleshoot API calls. A list\ \ of Web SDK event definitions appears in the Logging tree. Not every API method logs events. However, Web SDK and other\ \ events that occur appear on the General Log tab of a Policy folder or in the MMC Event Viewer snap-in." version: 26.1.1 servers: - url: / description: Current Host - url: https://REPLACEdnsnameME/ description: System - url: https://{dnsname}/ description: Configurable Hostname variables: dnsname: default: localhost description: Production API Hostname paths: /vedsdk/pki/hashicorp/role/: post: tags: - HashiCorp PKI APIs summary: Create a role description: "Create a role in Trust Protection Foundation.\r\n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreateRoleRequest_' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreateRoleResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/pki/hashicorp/role/{guid}: delete: tags: - HashiCorp PKI APIs summary: Remove policy enforcement settings description: "Remove policy enforcement settings for a HashiCorp Vault PKI role from Trust Protection Foundation.\r\n\ \r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Delete responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreateRoleResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] get: tags: - HashiCorp PKI APIs summary: Retrieve policy information description: "Retrieve policy information from Trust Protection Foundation about a HashiCorp Vault PKI role.\r\n\r\n\ _Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_GetByGuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_Role' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] put: tags: - HashiCorp PKI APIs summary: Update Trust Protection Foundation info description: "Update Trust Protection Foundation information about a HashiCorp role.\r\n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Update responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreateRoleResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: guid in: path description: '' required: true schema: type: string /vedsdk/pki/hashicorp/ca/{guid}: post: tags: - HashiCorp PKI APIs summary: Create or update roles description: "Create or update roles in the HashiCorp Vault PKI secrets engine according to the Trust Protection Foundation\ \ configuration.\r\n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_EnforceRoles responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] get: tags: - HashiCorp PKI APIs summary: Retrieve details description: "Retrieve details about a HashiCorp Vault PKI secrets engine.\r\n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_GetByGuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_PkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] put: tags: - HashiCorp PKI APIs summary: Update configuration description: "Update configuration for a HashiCorp Vault PKI secrets engine that is managed by Trust Protection Foundation.\r\ \n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Update responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] delete: tags: - HashiCorp PKI APIs summary: Remove PKI configuration description: "Remove configuration for managing a HashiCorp Vault PKI secrets engine from Trust Protection Foundation.\r\ \n\r\n_Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Delete responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: guid in: path description: '' required: true schema: type: string /vedsdk/pki/hashicorp/ca/{guid}/renew: post: tags: - HashiCorp PKI APIs summary: Initiate renewal or first time enrollment description: "Initiate renewal or first time enrollment of a HashiCorp Vault PKI intermediate CA certificate.\r\n\r\n\ _Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_EnrollAndProvision responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: guid in: path description: '' required: true schema: type: string /vedsdk/pki/hashicorp/ca/: post: tags: - HashiCorp PKI APIs summary: Define configuration description: "Define configuration for Trust Protection Foundation to manage the intermediate CA certificate.\r\n\r\n\ _Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_CreatePkiResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] get: tags: - HashiCorp PKI APIs summary: List all HashiCorp Vault PKI secrets description: "List all HashiCorp Vault PKI secrets engines that are managed by Trust Protection Foundation.\r\n\r\n\ _Required scope: certificate_" operationId: Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Get responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Drivers_Applications_HashiCorp_REST_Pkis' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedauth/authorize/device: post: tags: - Authentication Server APIs summary: Request a device grant description: "Triggers a grant request via device authorization flow (See RFC 8628 Section 3.1)\r\n\r\n_Required scope:\ \ Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_RequestDeviceAuth requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthRequest_device' required: true responses: '200': description: Grant issued content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse_device' '400': description: Grant issuance denied content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthError' /vedauth/authorize/oauth: post: tags: - Authentication Server APIs summary: Request a grant with user credentials. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_AuthorizeOAuth requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthRequest_oauth' required: true responses: '200': description: Grant issued content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse_oauth' '400': description: Grant issuance denied content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthError' /vedauth/authorize/integrated: post: tags: - Authentication Server APIs summary: Request a grant via NTLM/Kerberos description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_IntegratedAuthorize requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthRequest_integrated' required: true responses: '200': description: Grant issued content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse_integrated' '400': description: Grant issuance denied content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthError' /vedauth/authorize/certificate: post: tags: - Authentication Server APIs summary: Request a grant via certificate description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_CertificateAuthorize requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthRequest_certificate' required: true responses: '200': description: Grant issued content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse_certificate' '400': description: Grant issuance denied content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthError' /vedauth/authorize/jwt: post: tags: - Authentication Server APIs summary: Request a grant via JWT description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_JwtAuthorize requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthRequest_jwt' required: true responses: '200': description: Grant issued content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse_jwt' '400': description: Grant issuance denied content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthError' /vedauth/authorize/token: post: tags: - Authentication Server APIs summary: Refresh a bearer/device token description: "This endpoint supports refreshing bearer tokens as well as device access tokens (OAuth 2.0 Device Authorization\ \ Grant).\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_Token requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_TokenOAuthRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeOAuthResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedauth/authorize/verify: get: tags: - Authentication Server APIs summary: Verify bearer token validity description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_VerifyToken responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_AuthorizeVerifyResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedauth/authorize/IsAuthServer: get: tags: - Authentication Server APIs summary: Verify server availability description: "This endpoint can be used by a client to ensure the auth server is running before attempting to perform\ \ grant tasks\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Authorize_IsAuthServer responses: '200': description: Server available security: - AccessToken: [] /vedauth/revoke/token: get: tags: - Authentication Server APIs summary: Revoke grant description: "Revokes the grant passed in via a bearer token in the header\r\n\r\n_Required scope: Any_" operationId: Venafi_Web_SDK_Authentication_Revoke_RevokeGrant responses: '200': description: Grant revoked '202': description: Grant revocation failed security: - AccessToken: [] /vedsdk/certificates/Retrieve/{vaultId}: post: tags: - Certificate Management APIs summary: Retrieve a certificate by vault ID description: "Returns the available certificate data and optional private key information for an enrolled or archived\ \ certificate by its Vault Id.\r\nThe format property of the request allows to choose the following formats of the\ \ returned certificate binary data:\r\n* Base64\r\n* Base64 (PKCS #8)\r\n* DER\r\n* JKS:\r\n* PKCS #7\r\n* PKCS #12\r\ \n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveByVaultId requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveByVaultIdRequest_Retrieve__vaultId_' required: true responses: '200': description: Certificate retrieved successfully. The response body contains the certificate data and optional private key information. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse_Retrieve__vaultId_' '400': description: Invalid or missing request parameters. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse' security: - AccessToken: [] get: tags: - Certificate Management APIs summary: Retrieve a certificate by vault ID (GET) description: "Returns the available certificate data and optional private key information for an enrolled or archived\ \ certificate by its Vault Id.\r\nThe format property of the request allows to choose the following formats for the\ \ returned data:\r\n\r\n| Format | Response Content Type |\r\n| ---------------- | --------------------------------\ \ |\r\n| Base64 | application/x-pem-file |\r\n| Base64 (PKCS #8) | application/x-pem-file \ \ |\r\n| DER | application/x-x509-ca-cert |\r\n| JKS | application/octet-stream\ \ |\r\n| PKCS #7 | application/x-pkcs7-certificates |\r\n| PKCS #12 | application/x-pkcs12\ \ |\r\n\r\n_Required scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveByVaultIdGet parameters: - name: Format in: query schema: type: string - name: Password in: query schema: type: string - name: IncludePrivateKey in: query schema: type: string - name: IncludeChain in: query schema: type: string - name: RootFirstOrder in: query schema: type: string - name: FriendlyName in: query schema: type: string - name: KeystorePassword in: query schema: type: string - name: EncryptionAlgorithm in: query schema: type: string responses: '200': description: Returns the certificate as a binary stream. content: application/octet-stream: schema: $ref: '#/components/schemas/IO_Stream' '202': description: The certificate issuance is still pending. Use the /certificate/retrieve endpoint to obtain the certificate after it is issued. content: application/json: schema: $ref: '#/components/schemas/IO_Stream' '500': description: An internal error occurred during certificate retrieval processing. See the error message for details. content: application/json: schema: $ref: '#/components/schemas/IO_Stream' '400': description: ' Invalid or missing request parameters. See the error message for details.' content: application/json: schema: $ref: '#/components/schemas/IO_Stream' security: - AccessToken: [] parameters: - name: vaultId in: path description: The certificate data Vault Id. required: true schema: type: string /vedsdk/certificates/{guid}/PreviousVersions: get: tags: - Certificate Management APIs summary: Get archived certificates description: "Retrieves the archived versions of a certificate identified by its GUID. \r\nThe request can include query\ \ parameters to exclude expired or revoked certificates from the results. \r\nThe response contains a list of previous\ \ certificate versions, each with detailed information about the certificate.\r\n\r\n_Required scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePreviousVersions parameters: - name: ExcludeExpired in: query description: Exclude expired certificates required: true schema: type: string - name: ExcludeRevoked in: query description: Exclude revoked certificates required: true schema: type: string responses: '200': description: Previous certificate versions retrieved successfully. The response body contains the list of previous certificate versions. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PreviousVersionsResponse' '400': description: Invalid or missing request parameters. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PreviousVersionsResponse' security: - AccessToken: [] parameters: - name: guid in: path description: The certificate GUID required: true schema: type: string /vedsdk/certificates/Validate: post: tags: - Certificate Management APIs summary: Validate a deployed certificate description: "Initiates SSL/TLS network validation for one or more certificates and any associated applications.\r\n\ \r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateValidate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidateRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidateResponse' '400': description: Validation failed due to invalid or missing request parameters. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidateResponse' security: - AccessToken: [] /vedsdk/certificates/{guid}: put: tags: - Certificate Management APIs summary: Set or update certificate attributes description: "Sets or updates the attributes of a certificate identified by its GUID. \r\nThe request must include the\ \ certificate GUID in the path and the attribute data in the body. \r\nThe response indicates whether the operation\ \ was successful and includes any warnings or errors encountered during the process.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePut requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PutRequest__guid_' required: true responses: '200': description: 'Certificate attributes set or updated successfully. ' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PutResponse' '400': description: ' Invalid or missing request parameters. The Error property contains details about the failure.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PutResponse' security: - AccessToken: [] get: tags: - Certificate Management APIs summary: Get certificate details description: "Retrieves details and validation information about the certificate.\r\n\r\n_Required scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificateDetails responses: '200': description: Retrieve Certificate Details Complete. The response body contains the detailed information about the certificate. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DetailedCertificateResult' '500': description: An unexpected error occurred during the certificate details retrieval process. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DetailedCertificateResult' '400': description: The request was invalid due to incorrect parameters (e.g., invalid GUID). The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DetailedCertificateResult' security: - AccessToken: [] delete: tags: - Certificate Management APIs summary: Delete a certificate description: "Deletes a certificate object, all the associated objects including pending workflow tickets, and the corresponding\ \ vault information.\r\n\r\n_Required scope: certificate:delete_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateDelete responses: '200': description: The response body contains the result of the delete operation. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DeleteResponse' '400': description: The request was invalid due to incorrect parameters (e.g., invalid GUID, insufficient permissions). The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DeleteResponse' security: - AccessToken: [] parameters: - name: guid in: path description: The certificate GUID required: true schema: type: string /vedsdk/certificates/CheckPolicy: post: tags: - Certificate Management APIs summary: Check policy compliance description: "Performs a policy compliance assessment of a Certificate Signing Request (CSR) against a policy Distinguished\ \ Name (DN)\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CheckPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CheckPolicyRequest' required: true responses: '200': description: Policy compliance check completed successfully. The response includes the policy and Certificate Signing Request (CSR) data. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CheckPolicyResponse' '400': description: Invalid or missing request parameters. The Error property will provide details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CheckPolicyResponse' security: - AccessToken: [] /vedsdk/certificates/Request: post: tags: - Certificate Management APIs summary: Enroll or provision a certificate description: "Enrolls or provisions a new certificate.\r\n\r\n\r\n\r\nIf the certificate already exists, the current\ \ certificate archives to the History tab and the CA receives a new certificate request.\r\n\r\n\r\n\r\nBased on Policy\ \ tree settings, you can use a single Certificates/Request call to enroll or provision. \r\nThe same request can also:\r\ \n\r\n* Create one or more devices that will use the same certificate.\r\n* Allow one or more applications that run\ \ on a device to use the same certificate.\r\n* Create a certificate for an elastic instance. After the instance terminates,\ \ a tool, such as an Instance \r\nWatcher, can automatically clean up the certificate(and associated objects).\r\n\ * Set Custom Field values on a Certificate object. After a successful enrollment or provision, \r\nthe certificate\ \ appears in the Policy folder.However, if the \r\nissuing CA overrode values in the CSR, for example Organization\ \ Unit(OU), some fields may be empty.\r\n\r\n\r\n\r\n\r\n**NOTE:** Unless the _WorkToDoTimeout_ parameter is specified,\ \ this method will immediately return. If you want to wait for the certificate to be issued and returned in the response,\ \ specify how long you are willing to wait via _WorkToDoTimeout_. \r\n\r\n\r\n\r\n**Result code:**\r\n\r\n* 200 will\ \ be returned if the certificate request was accepted and the WorkToDoTimeout was not set.\r\n* 200 will be returned\ \ if the WorkToDoTimeout was set and the certificate is included in the response.\r\n* 202 will be returned if the\ \ certificate issuance is still pending. In this case, use the `/certificate/retrieve` endpoint to obtain the certificate\ \ after it is issued.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRequest requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RequestRequest' required: true responses: '200': description: The certificate request was accepted and the WorkToDoTimeout was not set, OR WorkToDoTimeout was set and the certificate is included in the response. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RequestResponse_Request' '202': description: The certificate issuance is still pending. In this case, use the `/certificate/retrieve` endpoint to obtain the certificate after it is issued. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RequestResponse' '500': description: Internal error occurred during certificate request processing. See error message for details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RequestResponse' '400': description: Invalid or missing request parameters. See error message for details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RequestResponse' security: - AccessToken: [] /vedsdk/certificates/Retrieve: post: tags: - Certificate Management APIs summary: Retrieve an issued certificate description: "Returns the available certificate data and optional private key information for an enrolled \r\ncertificate.\ \ \r\n\r\n\r\n\r\nAvailable options for `Format`:\r\n\r\n|Format | Content-Type |Description|\r\ \n|----------------|----------------------------------|----------------------------------|\r\n|Base64 | application/x-pem-file\ \ |Return the certificate in the traditional PEM format.|\r\n|Base64 (PKCS #8)| application/x-pem-file \ \ |Return the certificate in the PEM format and include the PKCS#8 encoded private key.|\r\n|DER \ \ | application/x-x509-ca-cert |Return the raw certificate. Use `IncludePrivateKey` and set the password.|\r\ \n|JKS | application/octet-stream |Return the certificate in the Java Keystore (JKS) format.|\r\ \n|PKCS #7 | application/x-pkcs7-certificates |Return the certificate with optional chain in the PKCS#7 format|\r\ \n|PKCS #12 | application/x-pkcs12 |Return the certificate in the PKCS#12 format. Use `IncludePrivateKey`\ \ and set the password.\"\r\n\r\n\r\n\r\n\r\n\r\n**Note:** This endpoint returns a JSON structure with the certificate\ \ data and other information. To download the raw certificate (in various formats), use the `GET /certificates/retrieve`\ \ endpoint.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveRequest_Retrieve' required: true responses: '200': description: The certificate retrieval was successful, and the certificate data is included in the response. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse' '202': description: The certificate issuance is still pending. Use the /certificate/retrieve endpoint to obtain the certificate after it is issued. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse' '500': description: An internal error occurred during certificate retrieval processing. See the error message for details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse' '400': description: ' Invalid or missing request parameters. See the error message for details.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetrieveResponse' security: - AccessToken: [] get: tags: - Certificate Management APIs summary: Retrieve an issued certificate (GET) description: "Returns the available certificate data and optional private key information for an enrolled certificate.\r\ \n\r\n\r\n\r\nThe response body contains the requested certificate in binary form.\r\n\r\n\r\n\r\nDepending on the\ \ requested format, the Content-Type will be:\r\n\r\n| Format | Content-Type |\r\n|------------------|----------------------------------|\r\ \n| BASE64 (pkcs #8) | application/x-pem-file |\r\n| BASE64 | application/x-pem-file \ \ |\r\n| DER | application/x-x509-ca-cert |\r\n| PKCS #7 | application/x-pkcs7-certificates\ \ |\r\n| PKCS #12 | application/x-pkcs12 |\r\n| JKS | application/octet-stream \ \ |\r\n\r\n\r\n\r\n\r\n**Note:** This API method matches `POST certificates/Retrieve`, except that all arguments\ \ are passed as part of the URL.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveGet parameters: - name: CertificateDN in: query description: The Distinguished Name (DN) of the certificate to be retrieved. required: true schema: type: string - name: Format in: query description: The format in which to retrieve the certificate (e.g., Base64, DER). required: true schema: type: string - name: Password in: query description: The password to use if the certificate includes a private key. (Required if IncludePrivateKey is true) required: true schema: type: string - name: KeystorePassword in: query description: The password for the Java Keystore (JKS) format. (Required if Format is JKS) required: true schema: type: string - name: FriendlyName in: query description: The friendly name for the certificate. (Required if Format is JKS) required: true schema: type: string - name: IncludePrivateKey in: query description: Indicates whether to include the private key in the response. required: true schema: type: string - name: IncludeChain in: query description: Indicates whether to include the certificate chain in the response. required: true schema: type: string - name: RootFirstOrder in: query description: Indicates whether to include the root certificate first in the chain. required: true schema: type: string - name: EncryptionAlgorithm in: query description: The encryption algorithm to use for the certificate. required: true schema: type: string - name: WorkToDoTimeout in: query description: The time to wait for the certificate to be issued before returning a response. required: true schema: type: string responses: '200': description: Returns the certificate as a binary stream. content: application/octet-stream: schema: $ref: '#/components/schemas/IO_Stream' '202': description: The certificate issuance is still pending. Use the /certificate/retrieve endpoint to obtain the certificate after it is issued. content: application/json: schema: $ref: '#/components/schemas/IO_Stream' '500': description: An internal error occurred during certificate retrieval processing. See the error message for details. content: application/json: schema: $ref: '#/components/schemas/IO_Stream' '400': description: ' Invalid or missing request parameters. See the error message for details.' content: application/json: schema: $ref: '#/components/schemas/IO_Stream' security: - AccessToken: [] /vedsdk/certificates/Renew: post: tags: - Certificate Management APIs summary: Renew a certificate description: "Requests immediate renewal for an existing certificate. A renewable certificate cannot be currently processing,\ \ in error, \r\nor contain a 'Monitoring' Management Type. \r\n\r\n\r\n\r\nOptionally, this API call can renew a previously\ \ disabled certificate.\r\n\r\n\r\n\r\n_The caller must have Write permission to the Certificate object that requires\ \ renewal._\r\n\r\n\r\n\r\n**NOTE:** Unless the _WorkToDoTimeout_ parameter is specified, this method will immediately\ \ return. If you want to wait for the certificate to be issued and returned in the response, specify how long you\ \ are willing to wait via _WorkToDoTimeout_. \r\n\r\n\r\n\r\n**Result code:**\r\n\r\n* 200 will be returned if the\ \ certificate request was accepted and the WorkToDoTimeout was not set.\r\n* 200 will be returned if the WorkToDoTimeout\ \ was set and the certificate is included in the response.\r\n* 202 will be returned if the certificate issuance is\ \ still pending. In this case, use the `/certificate/retrieve` endpoint to obtain the certificate after it is issued.\r\ \n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRenew requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RenewRequest' required: true responses: '200': description: The response body contains the renewed certificate data and other information. Returned if the certificate request was accepted and the WorkToDoTimeout was not set, OR WorkToDoTimeout was set and the certificate is included in the response. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RenewResponse_Renew' '202': description: Returned if the certificate issuance is still pending. In this case, use the `/certificate/retrieve` endpoint to obtain the certificate after it is issued. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RenewResponse' '500': description: An internal error occurred during certificate renewal processing. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RenewResponse' '400': description: The request was invalid due to missing or incorrect parameters (e.g., certificate not found, no PKCS#10 provided for a User Provided CSR). content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RenewResponse' security: - AccessToken: [] /vedsdk/certificates/Revoke: post: tags: - Certificate Management APIs summary: Revoke a certificate description: "Revokes an existing certificate. The request can be made using either the certificate's Distinguished\ \ Name (DN) or its Thumbprint. \r\nIf both are provided, the DN will be used. The revocation reason and comments are\ \ optional. \r\nIf the Disable parameter is set to true, the certificate will be disabled after revocation. \r\nThe\ \ WorkToDoTimeout parameter specifies the time to wait for the revocation process to complete before returning a response.\r\ \n\r\n_Required scope: certificate:revoke_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRevoke requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeRequest' required: true responses: '200': description: The certificate was successfully revoked. The Success property is true, and Revoked is true. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeResponse' '202': description: The revocation request has been submitted but is pending confirmation. The Success property is true, but Revoked remains false. A warning message may indicate the pending status. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeResponse' '500': description: An unexpected error occurred during revocation processing. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeResponse' '400': description: The request was invalid due to missing or incorrect parameters (e.g., certificate not found, no revocation reason provided). The Error property contains details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeResponse' '403': description: The request was denied due to insufficient permissions to revoke the certificate. The Error property contains details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RevokeResponse' security: - AccessToken: [] /vedsdk/certificates/: get: tags: - Certificate Management APIs summary: Search certificates description: "Returns certificate details and the total number of certificates that match the specified search filters.\r\ \n\r\n_Required scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificates parameters: - name: offset in: query description: Number of certificates to skip from the beginning. schema: type: string - name: limit in: query description: Number of certificates to take. schema: type: string - name: optionalfields in: query description: Comma separated list of optional fields. schema: type: string - name: createdon in: query description: Certificates created on the date and time. schema: type: string - name: createdongreater in: query description: Certificates created after the date and time. schema: type: string - name: createdonless in: query description: Certificates created before the date and time. schema: type: string - name: parentdn in: query description: Certificates in specific policies DN. schema: type: string - name: parentdnrecursive in: query description: Certificates below specific policies DN. schema: type: string - name: keysize in: query description: Certificates with the key size from the list. See also ParameterSet schema: type: string - name: keysizegreater in: query description: Certificates with the key size greater than the value. schema: type: string - name: keysizeless in: query description: Certificates with the key size less than the value. schema: type: string - name: stage in: query description: Certificates in any stage from the list. schema: type: string - name: stagegreater in: query description: Certificates in stage greater than the value. schema: type: string - name: stageless in: query description: Certificates in stage less than the value. schema: type: string - name: validto in: query description: Certificates with valid to as the date and time. schema: type: string - name: validtogreater in: query description: Certificates with valid to greater the date and time. schema: type: string - name: validtoless in: query description: Certificates with valid to less the date and time. schema: type: string - name: validfrom in: query description: Certificates with valid from as the date and time. schema: type: string - name: validfromgreater in: query description: Certificates with valid from greater the date and time. schema: type: string - name: validfromless in: query description: Certificates with valid from less the date and time. schema: type: string - name: pendingworkflow in: query description: Certificates with pending workflow. schema: type: string - name: validationstate in: query description: Certificates with specific validation state. schema: type: string - name: inerror in: query description: Certificates in error if value equals 1 or not provided, otherwise not in error. schema: type: string - name: disabled in: query description: Disabled certificates if value is 1 or not provided, otherwise enabled certificates. schema: type: string - name: name in: query description: Certificates with name from the list. schema: type: string - name: managementtype in: query description: Certificates with specific management type. schema: type: string - name: validationdisabled in: query description: Certificates with specific validation disabled string value. schema: type: string - name: networkvalidationdisabled in: query description: Certificates with specific network validation disabled string value. schema: type: string - name: certificatetype in: query description: Certificates with type from the list. schema: type: string - name: cn in: query description: Certificates with common name from the list. schema: type: string - name: c in: query description: Certificates with country from the list. schema: type: string - name: s in: query description: Certificates with state from the list. schema: type: string - name: l in: query description: Certificates with locality from the list. schema: type: string - name: o in: query description: Certificates with organization from the list. schema: type: string - name: issuer in: query description: Certificates with issue from the list. schema: type: string - name: serial in: query description: Certificates with serial from the list. schema: type: string - name: keyalgorithm in: query description: Certificates with key algorithm from the list. schema: type: string - name: signaturealgorithm in: query description: Certificates with signature algorithm from the list. schema: type: string - name: pkixparameterset in: query description: Certificates with a pkix parameter set oid from the list. (see 'PKIX Parameter Set' section under 'Certificate Management APIs') schema: type: string - name: ou in: query description: Certificates with any organization unit from the list. schema: type: string - name: san-dns in: query description: Certificates with any SAN DNS from the list. schema: type: string - name: san-ip in: query description: Certificates with any SAN IP from the list. schema: type: string - name: san-email in: query description: Certificates with any SAN email from the list. schema: type: string - name: san-uri in: query description: Certificates with any SAN URI from the list. schema: type: string - name: san-upn in: query description: Certificates with any SAN UPN from the list. schema: type: string - name: thumbprint in: query description: Certificates with thumbprint from the list. schema: type: string - name: contact in: query description: Certificates with any contact from the list. schema: type: string - name: approver in: query description: Certificates with any approver from the list. schema: type: string - name: isselfsigned in: query description: Self-signed certificates when the value is 1 or not provided; all certificates except self-signed when the value is 0. schema: type: string - name: iswildcard in: query description: Certificates with CN or any SAN DNS started with wildcard (*.) when the value is 1 or not provided; all certificates except the wildcard, when the value is 0. schema: type: string - name: ssltlsprotocol in: query description: Certificates with at least one consumer with validation protocol from the list. schema: type: string - name: tlsvalidationfailure in: query description: Certificates with at least one instance of the specified SSL/TLS Validation failure result from the list. schema: type: string - name: chainvalidationfailure in: query description: Certificates with at least one instance of the specified Chain Validation failure result from the list. schema: type: string responses: '200': description: The response body contains the list of certificates that match the specified search filters. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CertificateResults' '500': description: An unexpected error occurred during the certificate search process. The ErrorDetails property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CertificateResults' '400': description: The request was invalid due to incorrect parameters (e.g., invalid parent DN). The ErrorDetails property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_CertificateResults' security: - AccessToken: [] head: tags: - Certificate Management APIs summary: Get certificates count description: "Searches and returns the number of certificates that match the specified search filters.\r\n\r\n_Required\ \ scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificateCount parameters: - name: offset in: query description: Number of certificates to skip from the beginning. schema: type: string - name: limit in: query description: Number of certificates to take. schema: type: string - name: optionalfields in: query description: Comma separated list of optional fields. schema: type: string - name: createdon in: query description: Certificates created on the date and time. schema: type: string - name: createdongreater in: query description: Certificates created after the date and time. schema: type: string - name: createdonless in: query description: Certificates created before the date and time. schema: type: string - name: parentdn in: query description: Certificates in specific policies DN. schema: type: string - name: parentdnrecursive in: query description: Certificates below specific policies DN. schema: type: string - name: keysize in: query description: Certificates with the key size from the list. schema: type: string - name: keysizegreater in: query description: Certificates with the key size greater than the value. schema: type: string - name: keysizeless in: query description: Certificates with the key size less than the value. schema: type: string - name: stage in: query description: Certificates in any stage from the list. schema: type: string - name: stagegreater in: query description: Certificates in stage greater than the value. schema: type: string - name: stageless in: query description: Certificates in stage less than the value. schema: type: string - name: validto in: query description: Certificates with valid to as the date and time. schema: type: string - name: validtogreater in: query description: Certificates with valid to greater the date and time. schema: type: string - name: validtoless in: query description: Certificates with valid to less the date and time. schema: type: string - name: validfrom in: query description: Certificates with valid from as the date and time. schema: type: string - name: validfromgreater in: query description: Certificates with valid from greater the date and time. schema: type: string - name: validfromless in: query description: Certificates with valid from less the date and time. schema: type: string - name: pendingworkflow in: query description: Certificates with pending workflow. schema: type: string - name: validationstate in: query description: Certificates with specific validation state. schema: type: string - name: inerror in: query description: Certificates in error if value equals 1 or not provided, otherwise not in error. schema: type: string - name: disabled in: query description: Disabled certificates if value is 1 or not provided, otherwise enabled certificates. schema: type: string - name: name in: query description: Certificates with name from the list. schema: type: string - name: managementtype in: query description: Certificates with specific management type. schema: type: string - name: validationdisabled in: query description: Certificates with specific validation disabled string value. schema: type: string - name: networkvalidationdisabled in: query description: Certificates with specific network validation disabled string value. schema: type: string - name: certificatetype in: query description: Certificates with type from the list. schema: type: string - name: cn in: query description: Certificates with common name from the list. schema: type: string - name: c in: query description: Certificates with country from the list. schema: type: string - name: s in: query description: Certificates with state from the list. schema: type: string - name: l in: query description: Certificates with locality from the list. schema: type: string - name: o in: query description: Certificates with organization from the list. schema: type: string - name: issuer in: query description: Certificates with issue from the list. schema: type: string - name: serial in: query description: Certificates with serial from the list. schema: type: string - name: keyalgorithm in: query description: Certificates with key algorithm from the list. schema: type: string - name: signaturealgorithm in: query description: Certificates with signature algorithm from the list. schema: type: string - name: pkixparameterset in: query description: Certificates with parameter set oid from the list. schema: type: string - name: ou in: query description: Certificates with any organization unit from the list. schema: type: string - name: san-dns in: query description: Certificates with any SAN DNS from the list. schema: type: string - name: san-ip in: query description: Certificates with any SAN IP from the list. schema: type: string - name: san-email in: query description: Certificates with any SAN email from the list. schema: type: string - name: san-uri in: query description: Certificates with any SAN URI from the list. schema: type: string - name: san-upn in: query description: Certificates with any SAN UPN from the list. schema: type: string - name: thumbprint in: query description: Certificates with thumbprint from the list. schema: type: string - name: contact in: query description: Certificates with any contact from the list. schema: type: string - name: approver in: query description: Certificates with any approver from the list. schema: type: string - name: isselfsigned in: query description: Self-signed certificates when the value is 1 or not provided; all certificates except self-signed when the value is 0. schema: type: string - name: iswildcard in: query description: Certificates with CN or any SAN DNS started with wildcard (*.) when the value is 1 or not provided; all certificates except the wildcard, when the value is 0. schema: type: string - name: ssltlsprotocol in: query description: Certificates with at least one consumer with validation protocol from the list. schema: type: string - name: tlsvalidationfailure in: query description: Certificates with at least one instance of the specified SSL/TLS Validation failure result from the list. schema: type: string - name: chainvalidationfailure in: query description: Certificates with at least one instance of the specified Chain Validation failure result from the list. schema: type: string responses: '200': description: 'Success. The response header X-Record-Count contains the total number of matching certificates. ' '500': description: An unexpected error occurred during the certificate count process. security: - AccessToken: [] /vedsdk/certificates/Associate: post: tags: - Certificate Management APIs summary: Associate an application description: "Allows one or more application objects to use an existing certificate\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateAssociate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_AssociateRequest' required: true responses: '200': description: 'Certificate successfully associated with the specified application(s). The response includes Success: true, and the Warning field may contain additional messages related to the operation.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_AssociateResponse' '400': description: Invalid or missing request parameters. The Error property will provide details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_AssociateResponse' security: - AccessToken: [] /vedsdk/certificates/Dissociate: post: tags: - Certificate Management APIs summary: Dissociate an application description: "Detaches one or more application objects and corresponding device objects from an existing certificate.\r\ \n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateDissociate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DissociateRequest' required: true responses: '200': description: 'Certificate successfully dissociated from the specified application(s). The response includes Success: true, and the Error field will be null.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DissociateResponse' '400': description: Invalid or missing request parameters. The Error property will provide details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DissociateResponse' security: - AccessToken: [] /vedsdk/certificates/Push: post: tags: - Certificate Management APIs summary: Initiate provisioning description: "Initiates the certificate provisioning to some or all certificate consumers.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePush requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PushRequest' required: true responses: '200': description: 'Certificate successfully pushed to the specified application(s). The response includes Success: true, and the Warning field may contain additional messages related to the operation.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PushResponse' '400': description: Invalid or missing request parameters. The Error property will provide details. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_PushResponse' security: - AccessToken: [] /vedsdk/certificates/Import: post: tags: - Certificate Management APIs summary: Import a certificate description: "Imports a certificate and performs reconciliation\r\n\r\n_Required scope: certificate:discover_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateImport requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ImportRequest' required: true responses: '200': description: The certificate was imported successfully. The response body contains the result of the import operation. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ImportResponse' '400': description: Invalid or missing request parameters. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ImportResponse' security: - AccessToken: [] /vedsdk/certificates/Reset: post: tags: - Certificate Management APIs summary: Reset processing state description: "Resets the processing state of a certificate object and any associated applications.\r\n\r\n_Required\ \ scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_Reset requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ResetRequest' required: true responses: '200': description: Certificate processing state reset successfully. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ResetResponse' '400': description: Invalid or missing request parameters. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ResetResponse' security: - AccessToken: [] /vedsdk/certificates/Retry: post: tags: - Certificate Management APIs summary: Retry processing description: "Retries processing a certificate from its last unsuccessful lifecycle stage.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_Retry requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetryRequest' required: true responses: '200': description: Certificate processing retry successful. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetryResponse' '400': description: Invalid or missing request parameters. The Error property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_RetryResponse' security: - AccessToken: [] /vedsdk/certificates/{guid}/ValidationResults: get: tags: - Certificate Management APIs summary: Retrieve certificate validation results description: "Retrieves a list of validation results for the certificate.\r\n\r\n_Required scope: certificate_" operationId: Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetValidationResults responses: '200': description: Validation results retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidationResultsResponse' '400': description: The guid is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidationResultsResponse' '403': description: There are insufficient privileges to retrieve validation results. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidationResultsResponse' '500': description: There is an internal server error while retrieving validation results. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidationResultsResponse' '204': description: No validation results are found for the specified certificate. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_ValidationResultsResponse' security: - AccessToken: [] parameters: - name: guid in: path description: Guid representing the certificate for which to get validation results. required: true schema: type: string /vedsdk/discovery/Import: post: tags: - Discovery Management APIs summary: Import certificates description: "Adds or updates a set of network certificates into the Policy tree.\r\n\r\n_Required scope: certificate:discover_" operationId: Venafi_WebSDK_CertificateRequest_CertificateDiscoveryRest_PostDiscoveryResults requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DiscoveryImportRequest' required: true responses: '200': description: Discovery and import completed successfully. The response includes details on newly created and updated certificates. If warnings exist (e.g., some endpoints had no certificates), they are returned in the Warnings field. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DiscoveryImportResponse' '400': description: Invalid or missing request parameters. The Error property provides more details on why the request was rejected. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DiscoveryImportResponse' security: - AccessToken: [] /vedsdk/discovery/{guid}: delete: tags: - Discovery Management APIs summary: Delete a discovery job description: "Deletes a Network Discovery job including all stored results.\r\n\r\n_Required scope: certificate:delete_" operationId: Venafi_WebSDK_CertificateRequest_CertificateDiscoveryRest_DiscoveryDelete responses: '200': description: 'Network Discovery job deletion successful. The specified discovery job and all associated scan results were removed from the system. The response includes Success: true.' content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DiscoveryDeleteResponse' '400': description: Invalid or missing request parameters. The Error property will contain additional details on the failure reason. content: application/json: schema: $ref: '#/components/schemas/WebSDK_CertificateRequest_DiscoveryDeleteResponse' security: - AccessToken: [] parameters: - name: guid in: path description: The Globally Unique Identifier (GUID) of the Network Discovery job to be deleted. This must be a valid GUID in the correct format, and the job must exist in the system. required: true schema: type: string /vedsdk/codesign/FindEnvironment: post: tags: - CodeSigning APIs summary: Find Environment description: "Retrieves a project and environment based on the public key hash of the environment\r\n\r\n__Permissions:__\ \ \r\nThe caller must be assigned at least one role on the project\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_FindEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_FindEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_FindEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CreateEnvironment: post: tags: - CodeSigning APIs summary: Create Environment description: "Adds a new signing environment to a project. The environment manages the way applications will be code\ \ signed.\r\nThe environment only becomes active after a Code Signing Administrator approves the project.\r\n\r\n\ __Permissions:__ \r\nThe caller must be a Code Signing Administrator, or a member of any role on the project that\ \ owns the environment.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CreateEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CreateEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/DeleteEnvironment: post: tags: - CodeSigning APIs summary: Delete Environment description: "Removes a Code Sign Manager Environment and related objects such as keys and certificates.\r\n\r\n__Permissions:__\ \ \r\nThe caller must be a Code Signing Administrator, or a Owner.\r\n\r\n_Required scope: codesign:delete_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetEnvironment: post: tags: - CodeSigning APIs summary: Get Environment description: "Returns information about a signing environment. A signing describes the template where values\r\noriginate\ \ and other information for requesting a signing certificate from a CA.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator, or a member of any role on the project that owns the environment.\r\n\r\n_Required\ \ scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RenewEnvironment: post: tags: - CodeSigning APIs summary: Renew Environment description: "Renews a certificate for an environment, or rotates a key for an environment depending on the type of\ \ environment it is.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator, or a the Project\ \ Owner.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenewEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RenewEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RenewEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateEnvironment: post: tags: - CodeSigning APIs summary: Update Environment description: "Updates Code Sign Manager Environment settings that appear in an approved project.\r\n\r\nTo properly\ \ disable an environment, ensure the following steps are taken:\r\n* Disabled Flag: Set the 'Disabled' flag to true.\r\ \n* Status Property: Set the 'Status' property to 0, which corresponds to a specific enum value defined in SignProjectStatus.\r\ \n\r\n| Status Types | Value |\r\n| ---------------- | ------|\r\n| Disabled | 0\t |\r\n| Enabled \ \ | 1\t |\r\n| Draft | 2\t |\r\n| Pending | 3\t |\r\n| Deleted | 4 |\r\ \n| DisabledByParent | 5 |\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator, or a Owner.\r\ \n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateEnvironment requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateEnvironment' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateEnvironment' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/EnumerateProjects: post: tags: - CodeSigning APIs summary: Get Projects description: "Returns details about CyberArk Code Sign Manager projects.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator or a member of any role on the project.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateProjects requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateProjects' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateProjects' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetProject: post: tags: - CodeSigning APIs summary: Get Project description: "Returns information about a CyberArk Code Sign Manager project. \r\nThe project shows environments details\ \ like approvers and custom fields that appear in the API.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing\ \ Administrator or a member of any role on the project.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetProject requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetProject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetProject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CreateProject: post: tags: - CodeSigning APIs summary: Create Project description: "Creates an empty Code Sign Manager Project. \r\nAfter you create the project, use the Code Sign Manager\ \ MMC to add environments or POST Codesign/UpdateProject.\r\n\r\n* Signing Project settings are configurable via this\ \ REST API and in the VCC.\r\n* A project can also use settings from the global configuration.\r\n* After a project\ \ is approved, it is ready for code signing.\r\n* Administrators can monitor signing progress from the Codesigning\ \ UI.\r\n* A project has one or more collections, which are references, about signing applications or tools.\r\n*\ \ A project has one or more Environments and roles which are also known as rights.\r\n* Each environment references\ \ a template. The Environment also has certificates or keys and a signing flow.\r\nThe signing flow regulates the\ \ progress of application signing via a client. For more information, see Flow API.\r\n\r\n\r\n\r\n__Permissions:__\ \ \r\nNone. Projects are created in a Draft state and cannot be used until approved by an administrator.\r\n\r\n_Required\ \ scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateProject requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CreateProject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CreateProject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateProject: post: tags: - CodeSigning APIs summary: Update Project description: "Updates Code Sign Manager project and associated environment settings.\r\nYou can update information about\ \ a project even while it is in the draft state.\r\nLater, an administrator can approve the project.\r\n\r\n__Permissions:__\ \ \r\nThe caller must be a Code Signing Administrator, or a Owner.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateProject requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateProjectStatus: post: tags: - CodeSigning APIs summary: Update Project Status description: "Updates Code Sign Manager project status.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing\ \ Administrator, or a Owner.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateProjectStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProjectStatus' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProjectStatus' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/DeleteProject: post: tags: - CodeSigning APIs summary: Delete Project description: "Removes a Code Sign Manager project.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator,\ \ or a Owner.\r\n\r\n_Required scope: codesign:delete_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteProject requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteProject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteProject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RenameProject: post: tags: - CodeSigning APIs summary: Rename Project description: "Renames a Code Sign Manager project.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator,\ \ or a Owner.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameProject requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RenameProject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RenameProject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/EnumerateTemplates: post: tags: - CodeSigning APIs summary: Get Templates description: "Returns all user-defined CyberArk Code Sign Manager Environment Templates. \r\nUser-defined templates\ \ contain default settings that are either be required or suggested.\r\n\r\n__Permissions:__ \r\nThe caller must be\ \ a Code Signing Administrator or a member of any role on the project.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateEnvironmentTemplates requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateTemplates' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateTemplates' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetTemplate: post: tags: - CodeSigning APIs summary: Get Template description: "Returns information about a Code Sign Manager Environment Template.\r\n\r\n__Permissions:__ \r\nNone.\ \ Anyone can view templates. However, some templates may have limited visibility.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetEnvironmentTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetTemplate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetTemplate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CreateTemplate: post: tags: - CodeSigning APIs summary: Create Template description: "Creates a new, empty Code Sign Manager Environment template based on a TemplateType. \r\nUse other API\ \ calls to add suggested or required values to use in the parent Environment. \r\nAfter you finish the template, a\ \ Owner can create an environment from the template.\r\n\r\nOne or more environments can be used as part of a signing\ \ project. \r\nIf the project environment requires multiple signing keys, be sure to use the PerUser setting.\r\n\ Then, call POST Codesign/UpdateTemplate to apply macro settings for object creation.\r\n\r\n__Permissions:__ \r\n\ The caller must be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateEnvironmentTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CreateTemplate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CreateTemplate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateTemplate: post: tags: - CodeSigning APIs summary: Update Template description: "Updates or applies Code Sign Manager Environment Template settings.\r\nThe changes apply to all project\ \ environments that use this template.\r\n\r\nThe template _PerUser_ attribute is already set to true. To set the\ \ value, call POST Codesign/CreateTemplate.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator.\r\ \n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateEnvironmentTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateTemplate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateTemplate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/DeleteTemplate: post: tags: - CodeSigning APIs summary: Delete Template description: "Removes a Code Sign Manager Environment Template.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code\ \ Signing Administrator or application administrator.\r\n\r\n_Required scope: codesign:delete_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteEnvironmentTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteTemplate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteTemplate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RenameTemplate: post: tags: - CodeSigning APIs summary: Rename Template description: "Renames a Code Sign Manager Environment Template.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code\ \ Signing Administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameEnvironmentTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RenameTemplate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RenameTemplate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/EnumerateApplications: post: tags: - CodeSigning APIs summary: Get Applications description: "Returns information about tools that are used for signing applications.\r\n\r\n__Permissions:__ \r\nNone.\r\ \n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateApplications requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplications' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplications' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetApplication: post: tags: - CodeSigning APIs summary: Get Application description: "Returns information about a signing application that is known within Code Sign Manager.\r\n\r\n__Permissions:__\ \ \r\nNone. Anyone can view Applications\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CreateApplication: post: tags: - CodeSigning APIs summary: Create Application description: "Creates a blank entry for a signing application in Code Sign Manager.\r\n\r\n__Permissions:__ \r\nThe\ \ caller must be a Code Signing Administrator or Code Signing Application Administrator\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateApplication: post: tags: - CodeSigning APIs summary: Update Application description: "Updates the attributes of a signing application in Code Sign Manager. \r\nWhen you call Codesign/UpdateApplication,\ \ all attributes of a Application \r\nobject for Code Sign Manager automatically update.\r\n\r\n__Permissions:__ \r\ \nThe caller must be a Code Signing Administrator or application administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/DeleteApplication: post: tags: - CodeSigning APIs summary: Delete Application description: "Removes information about a signing application in Code Sign Manager. \r\nReferences to the application\ \ are removed from Projects and ApplicationGroups.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator\ \ or application administrator.\r\n\r\n_Required scope: codesign:delete_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RenameApplication: post: tags: - CodeSigning APIs summary: Rename Application description: "Renames a signing application entry in Code Sign Manager. The actual signing tool name remains unchanged.\r\ \n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator or application administrator.\r\n\r\n_Required\ \ scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CountReferences: post: tags: - CodeSigning APIs summary: Get Application Reference Count description: "Returns the number of references to a signing application or a signing application collection that are\ \ currently \r\nin use within Code Sign Manager projects.\r\n\r\n__Permissions:__ \r\nnone.\r\n\r\n_Required scope:\ \ codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CountReferences requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CountReferences' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CountReferences' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/EnumerateReferences: post: tags: - CodeSigning APIs summary: Get Application Reference description: "Returns the location of a signing application or collection of signing tools.\r\n\r\n__Permissions:__\ \ \r\nNone.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateReferences requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateReferences' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateReferences' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/EnumerateApplicationCollections: post: tags: - CodeSigning APIs summary: Get All Applications Collections description: "Returns information about every signing application collection.\r\n\r\n__Permissions:__ \r\nNone. Anyone\ \ can view application collections.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateApplicationCollections requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplicationCollections' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplicationCollections' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetApplicationCollection: post: tags: - CodeSigning APIs summary: Get Application Collections Info description: "Returns information about a signing application collection. Application collections appear in the Signing\ \ Applications node of VCC.\r\n\r\n__Permissions:__ \r\nNone. Anyone can view application collections.\r\n\r\n_Required\ \ scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollection requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollection' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollection' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetApplicationCollectionMemberDNs: post: tags: - CodeSigning APIs summary: Get Application Collection Member DNs description: "Returns the members of an application collection. Application collection member include ApplicationDNs\ \ and any ApplicationCollectionDNs.\r\n\r\n__Permissions:__ \r\nNone. Anyone can view application collections.\r\n\ \r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollectionMemberDNs requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMemberDNs' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMemberDNs' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetApplicationCollectionMembers: post: tags: - CodeSigning APIs summary: Get Members of Application Collection description: "Resolves the members of this collection into full Applications and ApplicationCollections.\r\n\r\n__Permissions:__\ \ \r\nNone. Anyone can view application collections.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollectionMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMembers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMembers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/CreateApplicationCollection: post: tags: - CodeSigning APIs summary: Create Application Collection description: "Creates a new blank signing application collection. An application collection is a set of signing tools.\ \ \r\nFor example, the collection can group the most commonly used tools. \r\nThe new collection appears in the Signing\ \ Applications node of VCC. \r\nTo add signing tools, call POST Codesign/UpdateApplicationCollection.\r\n\r\n__Permissions:__\ \ \r\nThe caller must be a Code Signing Administrator or application administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateApplicationCollection requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplicationCollection' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplicationCollection' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/UpdateApplicationCollection: post: tags: - CodeSigning APIs summary: Update Application Collection description: "Updates the set signing tools in an Application collection.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator or application administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateApplicationCollection requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplicationCollection' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplicationCollection' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/DeleteApplicationCollection: post: tags: - CodeSigning APIs summary: Delete Application Collection description: "Deletes a collection of signing applications.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing\ \ Administrator or application administrator.\r\n\r\n_Required scope: codesign:delete_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteApplicationCollection requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplicationCollection' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplicationCollection' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RenameApplicationCollection: post: tags: - CodeSigning APIs summary: Rename Application Collection description: "Renames a signing Application collection.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing\ \ Administrator or application administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameApplicationCollection requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplicationCollection' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplicationCollection' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetGlobalConfiguration: get: tags: - CodeSigning APIs summary: Get Global Configuration description: "Returns settings that apply to all Code Sign Manager projects.\r\n\r\n__Permissions:__ \r\nThe caller\ \ is not required to have any special permissions.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetGlobalConfiguration responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetGlobalConfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/SetGlobalConfiguration: post: tags: - CodeSigning APIs summary: Set Global Configuration description: "Updates global configuration settings for Code Sign Manager.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_SetGlobalConfiguration requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_SetGlobalConfiguration' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_SetGlobalConfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/AddAdministrator: post: tags: - CodeSigning APIs summary: Assign Admin Rights to Trustee description: "Grants Code Signing Administrator rights to allow a trustee to administer any Code Sign Manager project.\r\ \n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddAdminiStrator requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_AddAdministrator' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_AddAdministrator' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RemoveAdministrator: post: tags: - CodeSigning APIs summary: Remove Admin Rights from Trustee description: "Revokes Code Signing Administrator rights from a trustee.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveAdministrator requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveAdministrator' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveAdministrator' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/AddApplicationAdministrator: post: tags: - CodeSigning APIs summary: Add Application Admin Rights description: "Grants Code Signing Application Administrator rights to a trustee. \r\nThe Code Signing Application Administrator\ \ has permissions to Application and ApplicationCollection \r\nobjects in Code Sign Manager.\r\n\r\n__Permissions:__\ \ \r\nThe caller must be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddApplicationAdminiStrator requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_AddApplicationAdministrator' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_AddApplicationAdministrator' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RemoveApplicationAdministrator: post: tags: - CodeSigning APIs summary: Remove Application Admin Rights description: "Revokes Code Signing Application Administrator rights from a trustee.\r\n\r\n__Permissions:__ \r\nThe\ \ caller must be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveApplicationAdministrator requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveApplicationAdministrator' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveApplicationAdministrator' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/AddProjectApprover: post: tags: - CodeSigning APIs summary: Add Project Approver description: "Grants Project Approval rights to a trustee to sign projects.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddProjectApprover requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_AddProjectApprover' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_AddProjectApprover' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RemoveProjectApprover: post: tags: - CodeSigning APIs summary: Remove Project Approver description: "Revokes Key Use Approver rights from a trustee.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code\ \ Signing Administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveProjectApprover requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveProjectApprover' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveProjectApprover' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetRight: post: tags: - CodeSigning APIs summary: Get Caller Rights for Project description: "Returns caller rights for a given Code Sign Manager object.\r\n\r\n__Permissions:__ \r\nNone.\r\n\r\n\ _Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetRight requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetRight' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetRight' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetTrusteeRights: post: tags: - CodeSigning APIs summary: Get Trustee Rights description: "Returns all Code Sign Manager code signing rights for a user.\r\n\r\n__Permissions:__ \r\nThe caller must\ \ be a Code Signing Administrator or application administrator.\r\n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetTrusteeRights requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetTrusteeRights' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetTrusteeRights' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/GetObjectRights: post: tags: - CodeSigning APIs summary: Get Object Rights description: "Returns all identities that have rights to a Code Sign Manager object.\r\nAn identity or trustee can be\ \ an AD, LDAP, or local user or group.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing Administrator.\r\ \n\r\n_Required scope: codesign:admin_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetObjectRights requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_GetObjectRights' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_GetObjectRights' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/AddPreApproval: post: tags: - CodeSigning APIs summary: Add Flow Staging Information for a Pre-Approval description: "Applies a Flow pre-approval for private key use. The Pre-Approval, which is defined in VCC, \r\ntemporarily\ \ overrides and disables any existing approval stages that prevent private key use. \r\nPre-Approval only disables\ \ approval stages if the Key Use Flow is configured with a Code Sign \r\nManager Pre-Approval action.\r\n\r\n_NOTE\ \ If you are working with real-time Flow Tickets (for example, a request that is pending approval), use the Flow\ \ API instead._\r\n\r\n__Prerequisites:__\r\nEach project uses an environment template. In VCC, configure a Key Use\ \ Flow that contains a Pre-Approval action. \r\nBefore calling AddPreApproval, make sure the flow is assigned to the\ \ template, For more information, see Configure Code Signing Flows.\r\n\r\n__Permissions:__\r\n\r\n_Required scope:\ \ codesign:approve_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_PreApprove requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_AddPreApproval' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_AddPreApproval' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RunMacro: post: tags: - CodeSigning APIs summary: Run Macro Info description: "Run Macro\r\n\r\n__Permissions:__\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RunMacro requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RunMacro' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RunMacro' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/RetrieveArchiveEntries: post: tags: - CodeSigning APIs summary: Retrieve Sign Archive Entries description: "Returns data about code signing operations. This API is useful for administrators or\r\nauditors who need\ \ detailed information about the use of signing keys.\r\n\r\n__Permissions:__ \r\nThe caller must be a Code Signing\ \ Administrator, Code Signing Auditor, Trust Protection Foundation Auditor, or Trust Protection Foundation Master\ \ Admin.\r\n\r\n_Note:_ Code Signing Auditors will see results only from the Code Singing Projects where they are\ \ identified as an auditor.\r\n\r\n_Required scope: codesign:manage_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RetrieveArchiveEntries requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_RetrieveArchiveEntries' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_RetrieveArchiveEntries' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/codesign/ExportSignArchive: post: tags: - CodeSigning APIs summary: Exports Sign Archive Entries description: "Returns a file containing the CSV representation of the Sign Archive after the input filters get applied.\ \ \r\n\r\n__Permissions:__ \r\nScope required for this is Master Admin, System Auditor, Code Signig Admin, or a Code\ \ Signing Auditor.\r\n\r\n_Note:_ The filter attributes SortOder and SortBy are ignored by this endpoint. \"AfterEntryId\"\ \ and \"Page\" are mutually exclusive. The former takes precedence.\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_ExportSignArchive requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_ExportSignArchive' required: true responses: '200': description: Success '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] get: tags: - CodeSigning APIs summary: Exports Sign Archive Entries, no filtering description: "Returns a file containing the CSV representation of Code Signing Archive Entries\r\n\r\n__Permissions:__\ \ \r\nScope required for this is Master Admin, System Auditor, Code Signig Admin, or a Code Signing Auditor.\r\n\r\ \n_Note_: This endpoint will default the filtering values and up to 100K entries. For further paging and/or filtering\ \ do POST request\r\n\r\n_Required scope: codesign_" operationId: Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetExportSignArchive responses: '200': description: Success '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/actions/codesign/prequalify/Create: post: tags: - CodeSigning APIs summary: Pre-qualify approval flow description: "Pre-qualifies and adds a hash to a VCC Flow that already has a Pre-Qualified Signature action. However,\ \ the hash is hidden in VCC and CodeSign Protect.\r\n\r\nHash data ensures the identity of a specific assembly or\ \ executable. Later, during code signing, if the software hash does not match the pre-qualified hash, code signing\ \ fails.\r\n\r\nYou can add as many hashes as necessary to a project environment Flow. However, you must call PreQualify/Create\ \ to preauthorize each hash so it is available for future code signing.\r\n\r\n__Permissions:__ The caller, who pre-authorizes\ \ the hash, must be a Key Use Approver.\r\n\r\n_Required scope: codesign:approve_" operationId: Venafi_WebSDK_Product_CodeSigning_PreQualifiedDataRest_CreatePreQualified requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningRequest_Create' required: true responses: '200': description: Pre-qualification created content: application/json: schema: $ref: '#/components/schemas/WebSDK_Product_CodeSigning_CodeSigningResponse_Create' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/credentials/adaptable/create: post: tags: - Credential APIs summary: Create Adaptable credential description: "Create an Adaptable Credential, which is a reference to a vault secret.\r\n\r\n_Required scope: security:manage_" operationId: Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_create' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/credentials/adaptable/update: post: tags: - Credential APIs summary: Update Adaptable credential description: "Update field values in an Adaptable Credential.\r\n\r\n_Required scope: security:manage_" operationId: Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_update' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_update' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/credentials/cyberark/create: post: tags: - Credential APIs summary: Create CyberArk credential description: "Create an entry in the policy folder to match credential information in a CyberArk Safe.\r\n\r\n_Required\ \ scope: security:manage_" operationId: Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse' /vedsdk/credentials/cyberark/update: post: tags: - Credential APIs summary: Update CyberArk credential. description: "Update credentials to match credential information in a CyberArk Safe.\r\n\r\n_Required scope: security:manage_" operationId: Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse' /vedhsm/api/signjwt: post: tags: - CodeSigning HSM API summary: Signs JSON Web Token description: "Signs and returns a JSON Web Token (JWT). Because a Code Sign Manager certificate\r\ndigitally signed\ \ the token, the claims in the token can be verified and trusted.\r\n\r\nThe **ResultData** object that is returned\ \ is a URL Safe Base-64 encoded value of the signed JWT. \r\nIf this API call was unsuccessful, the value is missing.\ \ After you use a tool to convert \r\nthis value to JSON, the value includes these JOSE headers: \r\n* typ: JWT.\r\ \n* alg: The algorithm.\r\n* kid: The key ID.\r\n* x5u: The resource for the X.509 public key of a certificate or\ \ certificate chain.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleSignJWT requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmJWTRequest_signjwt' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmJWTResponse_signjwt' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/IsHsm: get: tags: - CodeSigning HSM API summary: Verify HSM Server Info description: "Returns _OK_. Allows clients to verify if they have the right HSM server URL. No authorization required.\r\ \n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_IsAuthServer responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmBaseResponse_IsHsm' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/sign: post: tags: - CodeSigning HSM API summary: Sign Data description: "Requests that data be digitally signed. During signing, Code Sign Manager uses a \r\nprivate key from\ \ a project's environment to sign the data (provided as base64)\r\nand return raw signature. If the signing operation\ \ is blocked by a Flow that requires \r\nkey use approval, a digest is returned that uniquely identifies the signing\ \ request.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleSign requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoRequest_sign' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/decrypt: post: tags: - CodeSigning HSM API summary: Decrypts Data description: "Decrypts Data\r\nOn success, a valid _HsmCryptoResponse_ with the decrypted data. \r\nOn failure, the\ \ _Error_ holds the failure reason\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleDecrypt requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoRequest_decrypt' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoResponse_decrypt' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/derive: post: tags: - CodeSigning HSM API summary: Derives a Key description: "Derives a Key\r\n\r\nPerforms Diffie-Hellman key exchange. On success, a valid HsmCryptoResponse with\ \ the derived key data will be returned.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleDerive requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoRequest_derive' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmCryptoResponse_derive' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/getgpgpublickey: post: tags: - CodeSigning HSM API summary: Get GPG public key description: "Retrieves a GNU Privacy Guard (GPG) public key and the hu location in the \r\nWeb Key Directory (WKD)\ \ of the Code Signing Key Server. This server is an \r\nimplementation of various key discovery mechanisms such as\ \ GPG WKD and GPG PKS.\r\n\r\nThis action is similar to PKCS11Config.exe -gpg sync.This endpoint automatically \r\n\ syncs the public key to the caller's machine. The GPG public key verifies authenticity.\r\nIt is available for code\ \ signing electronic information such as email and smart card data.\r\nHowever, the corresponding private key, which\ \ is in the Secret Store, is not shared.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleGetGpgPublicKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmGpgRequest_getgpgpublickey' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmGpgResponse_getgpgpublickey' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/storeobject: post: tags: - CodeSigning HSM API summary: Stores a key within an environment description: "Stores a key within an environment.\r\n\r\n__Permissions:__ \r\nThe caller must be a CodeSign Admin, Master\ \ Admin, or a Project Owner.\r\n\r\nScope: codesign:manage\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleStoreObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmStoreRequest_storeobject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmStoreResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/getchain: post: tags: - CodeSigning HSM API summary: Get Certificate Chain description: "Returns HSM objects with the certificate chain for a certificate object\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleGetChain requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmObjectRequest_getchain' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmObjectResponse_getchain' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/getobjects: post: tags: - CodeSigning HSM API summary: Get Objects description: "Retrieves information that the caller can use in code signing.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleGetAll requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmObjectRequest_getobjects' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmObjectResponse_getobjects' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedhsm/api/csctelemetry: post: tags: - CodeSigning HSM API summary: Code Sign Client Telemetry description: "Requests that a message from the Code Sign Client is recorded in telemetry. This may include incrementing\ \ stats counters, writing to logs, sending data to Pendo, etc.\r\n\r\n_Required scope: codesignclient_" operationId: Venafi_Web_Hsm_HsmAPI_HandleTelemetry requestBody: content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmTelemetryRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Web_Hsm_HsmTelemetryResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedscim/{owner}/available: get: tags: - System Status APIs summary: Get provider-specific SCIM endpoint status description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Scim_Server_Endpoints_GetCheckAvailable responses: '202': description: The SCIM endpoint for the given owner is active content: application/json: schema: $ref: '#/components/schemas/IO_Stream' '404': description: The SCIM endpoint for the given owner is not active content: application/json: schema: $ref: '#/components/schemas/IO_Stream' security: - AccessToken: [] parameters: - name: owner in: path description: The friendly name of the SCIM provider required: true schema: type: string /vedscim/available: get: tags: - System Status APIs summary: Get SCIM Server endpoint status description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Scim_Server_Endpoints_GetCheckGlobalAvailable responses: '202': description: The SCIM endpoint is active content: application/json: schema: $ref: '#/components/schemas/IO_Stream' security: - AccessToken: [] /vedsdk/client/: get: tags: - Client Management APIs summary: Search client records description: "Returns clients matching the filter items\r\n\r\n_Required scope: agent_" operationId: ClientWebSDK_ClientSdkService_Get parameters: - name: ClientVersion in: query description: The exact Trust Protection Foundation agent version number schema: type: string - name: ClientType in: query description: The exact registered client category schema: type: string - name: HostName in: query description: The exact or partial hostname, Fully Qualified Domain Name (FQDN), or domain name where the registered client is installed schema: type: string - name: IPAddress in: query description: The exact IPv4 or IPV6 address of the system where the registered client is installed schema: type: string - name: LastSeenOn in: query description: The exact date of clients connecting to Trust Protection Foundation schema: type: string - name: LastSeenOnGreater in: query description: Find information about clients connecting to Trust Protection Foundation after this exact UTC time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmmmZ) schema: type: string - name: LastSeenOnLess in: query description: Find information about all clients connecting to Trust Protection Foundation before this exact UTC time. For a time range, make sure the LastSeenOnGreater time is older than the LastSeenOnLess time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmmmZ) schema: type: string - name: MACAddress in: query description: The exact or partial MAC address where the registered client is installed schema: type: string - name: OSName in: query description: The exact operating system name of the system where the registered client is installed schema: type: string - name: OSVersion in: query description: The exact operating system version of the system where the registered client is installed schema: type: string - name: Region in: query description: The set of clients for a particular geographic area, such as a state or territory schema: type: string - name: SerialNumber in: query description: The exact or partial hardware serial number of the system where the registered client is installed schema: type: string - name: SID in: query description: The exact Security Identifier (SID) that corresponds to the UserName that is registered with the client schema: type: string - name: UserName in: query description: The exact or partial domain or local user name that runs the registered client schema: type: string - name: VirtualMachineId in: query description: The virtual machine identifier from the UI schema: type: string responses: '200': description: The request was successful, and the response contains the requested client records. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail '204': description: The request was successful, but no client records matched the provided filters. The response does not contain any content. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail '400': description: The request was invalid. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail security: - AccessToken: [] /vedsdk/client/details/: get: tags: - Client Management APIs summary: Search client records (details) description: "Returns clients, including details, matching the filter items\r\n\r\n_Required scope: agent_" operationId: ClientWebSDK_ClientSdkService_GetDetails parameters: - name: WorkType in: query description: The tasks that a group of agents can perform. schema: type: string responses: '200': description: The request was successful, and the response contains the requested client records. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail '204': description: The request was successful, but no client records matched the provided filters. The response does not contain any content. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail '400': description: The request was invalid. content: application/json: schema: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail security: - AccessToken: [] /vedsdk/client/delete: post: tags: - Client Management APIs summary: Delete client records description: "Deletes client records in bulk based on the supplied list of clients.\r\n\r\n_Required scope: agent:delete_" operationId: ClientWebSDK_ClientSdkService_Delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientWebSDK_DataContracts_BulkRequest' required: true responses: '200': description: 'Client records deleted successfully. ' content: application/json: schema: $ref: '#/components/schemas/ClientWebSDK_DataContracts_DeleteResponse_delete' security: - AccessToken: [] /vedsdk/client/work/: get: tags: - Client Management APIs summary: Get own work description: "Returns all work objects applicable to the caller.\r\n\r\n_Required scope: agent_" operationId: ClientWebSDK_ClientSdkService_GetUserWork parameters: - name: WorkType in: query description: The tasks that a group of agents can perform. schema: type: string responses: '200': description: The request was successful, and the response contains the requested work objects applicable to the caller. content: application/json: schema: type: array items: type: object properties: WorkName: type: string description: Work name WorkDn: type: string description: Work DN WorkType: type: string description: Work Type AssociatedGroups: type: array items: type: string description: Associated groups description: Represents a work that applies user making request via WebSdk '204': description: The request was successful, but no work objects matched the provided filters. The response does not contain any content. content: application/json: schema: type: array items: type: object properties: WorkName: type: string description: Work name WorkDn: type: string description: Work DN WorkType: type: string description: Work Type AssociatedGroups: type: array items: type: string description: Associated groups description: Represents a work that applies user making request via WebSdk '400': description: Request was invalid due to session issues, unsupported query parameters, or failure to get user network details. content: application/json: schema: type: array items: type: object properties: WorkName: type: string description: Work name WorkDn: type: string description: Work DN WorkType: type: string description: Work Type AssociatedGroups: type: array items: type: string description: Associated groups description: Represents a work that applies user making request via WebSdk security: - AccessToken: [] /vedsdk/algorithmselector/get: post: tags: - AlgorithmSelector APIs summary: Get the algorithm configured for an object description: "Returns the currently configured algorithm selector for the specified object\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_Get requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_get' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_get' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/commit: post: tags: - AlgorithmSelector APIs summary: Set the algorithm configured for an object description: "Configures the specified object to use the provided algorithm\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_Commit requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_commit' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_commit' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/find: post: tags: - AlgorithmSelector APIs summary: Find algorithm selectors for a specific security strength description: "Returns the list of algorithms that match the provided strength category\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_Find requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_find' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_find' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/getpolicy: post: tags: - AlgorithmSelector APIs summary: Get the allowed algorithms for a container description: "Returns the algorithm selectors that are allowed for objects of the specified class that are children\ \ of this container\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_GetPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_getpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_getpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/commitpolicy: post: tags: - AlgorithmSelector APIs summary: Set the allowed algorithms for a container description: "Configures the specified container to limit use of algorithms to the provided algorithm list\r\n\r\n_Required\ \ scope: configuration:manage_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_CommitPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_commitpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_commitpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/getselector: post: tags: - AlgorithmSelector APIs summary: Get details about an algorithm description: "Returns the algorithm matching the provided PKIX Parameter Set Oid\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_GetOid requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_getselector' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_getselector' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/getallselectors: post: tags: - AlgorithmSelector APIs summary: Get all algorithms description: "Retrieve all known algorithm definitions\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_GetAllAlgorithms requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_getallselectors' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/getallowedalgorithms: post: tags: - AlgorithmSelector APIs summary: Get allowed algorithms for an object description: "Retrieve the list of algorithms available for use. If **SchemaClass** is provided,\r\ngets the algorithms\ \ allowed for use by children of the specified object matching the \r\nclass. Otherwise gets the allowed algorithms\ \ for use by the specified object itself.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_GetAllowedAlgorithms requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_getallowedalgorithms' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_getallowedalgorithms' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/getglobalalgorithms: post: tags: - AlgorithmSelector APIs summary: Get the globally allowed algorithms description: "Returns the globally allowed algorithms ordered by priority\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_GetGlobalAlgorithms requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_getglobalalgorithms' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/algorithmselector/setglobalalgorithms: post: tags: - AlgorithmSelector APIs summary: Set the globally allowed algorithms description: "Algorithm priority is set based on the order of the oids provided\r\n\r\n_Required scope: admin:algorithms_" operationId: Venafi_Core_WebSDK_AlgorithmSelectorRest_SetGlobalAlgorithms requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebRequest_setglobalalgorithms' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AlgorithmSelectorWebResponse_setglobalalgorithms' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/enumerate: post: tags: - Flow APIs summary: Enumerate pending tickets. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_FlowTicketRest_EnumerateTickets requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_enumerate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_enumerate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/enumerateapproved: post: tags: - Flow APIs summary: Enumerate approved and still in use tickets. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_FlowTicketRest_EnumerateApproved requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_enumerateapproved' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_enumerateapproved' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/approve: post: tags: - Flow APIs summary: Approve one or more pending tickets. description: "\r\n\r\n_Required scope: :approve_" operationId: Venafi_Core_WebSDK_FlowTicketRest_Approve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_approve' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_approve' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/reject: post: tags: - Flow APIs summary: Reject one or more pending tickets. description: "\r\n\r\n_Required scope: :approve_" operationId: Venafi_Core_WebSDK_FlowTicketRest_Reject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_reject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_reject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/count: post: tags: - Flow APIs summary: Count pending tickets. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_FlowTicketRest_Count requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_count' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_count' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/countapproved: post: tags: - Flow APIs summary: Count approved tickets. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_FlowTicketRest_CountApproved requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_countapproved' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_countapproved' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/load: post: tags: - Flow APIs summary: Load a single ticket description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_FlowTicketRest_LoadSingle requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_load' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_load' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/flow/tickets/update: post: tags: - Flow APIs summary: Update existing approval description: "\r\n\r\n_Required scope: :approve_" operationId: Venafi_Core_WebSDK_FlowTicketRest_UpdateExisting requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketRequest_update' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FlowTicketResponse_update' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/serverstatus/idle: get: tags: - Platform APIs summary: Check if idle description: "This call is the inverse of **active**\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ServerStatusRest_GetStandby responses: '200': description: Server is idle '404': description: Server is active security: - AccessToken: [] /vedsdk/serverstatus/active: get: tags: - Platform APIs summary: Check if active description: "This call is the inverse of **idle**\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ServerStatusRest_GetActive responses: '200': description: Server is active '404': description: Server is idle security: - AccessToken: [] /vedsdk/SystemStatus/: get: tags: - System Status APIs summary: Get all engines description: "Returns a list of all engines with details\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_Get responses: '200': description: All engines returned content: application/json: schema: type: array items: type: object properties: engineDN: type: string description: DN of the engine the data describes engineName: type: string description: Name of the engine services: type: object properties: iis: type: object properties: modules: type: array items: type: string description: A list of loaded components timeSinceFirstSeen: type: string description: First seen (ISO 8601 Format) timeSinceLastSeen: type: string description: Last seen (ISO 8601 format) status: type: string description: IIS Status configuredMode: type: string description: Configured standby mode currentMode: type: string description: Current standby mode configuredLatency: type: integer description: DB latency for entering standby format: int32 nullable: true currentLatency: type: integer description: Current DB latency format: int32 nullable: true configuredWork: type: integer description: The configured number of work items pending before service becomes active format: int32 nullable: true currentWork: type: integer description: The current number of work items applicable for the service format: int32 nullable: true description: "IIS Information \nThe following table shows the module names used for IIS endpoints\r\ \n\r\n| Endpoint | Module Name |\r\n|------------|----------------------|\r\n| /aperture\ \ | Venafi.Aperture.Core |\r\n| /vacme | Acme.Server |\r\n| /vedsdk | WebSDK\ \ |\r\n| /vedclient | ClientRest |\r\n| /vedauth | AuthServer \ \ |\r\n| /vedhsm | Hsm |\r\n| /vedadmin | Venafi.Admin.Web |\r\n\ | /timestamp | TimeStamp |\r\n| /vedscep | VScep |\r\n| /certsrv \ \ | VScep |\r\n| /pks | KeyServer |" logServer: type: object properties: modules: type: array items: type: string description: A list of loaded components timeSinceFirstSeen: type: string description: First seen (ISO 8601 Format) timeSinceLastSeen: type: string description: Last seen (ISO 8601 format) status: type: string description: IIS Status configuredMode: type: string description: Configured standby mode currentMode: type: string description: Current standby mode configuredLatency: type: integer description: DB latency for entering standby format: int32 nullable: true currentLatency: type: integer description: Current DB latency format: int32 nullable: true configuredWork: type: integer description: The configured number of work items pending before service becomes active format: int32 nullable: true currentWork: type: integer description: The current number of work items applicable for the service format: int32 nullable: true description: LogServer Information vPlatform: type: object properties: modules: type: array items: type: string description: A list of loaded components timeSinceFirstSeen: type: string description: First seen (ISO 8601 Format) timeSinceLastSeen: type: string description: Last seen (ISO 8601 format) status: type: string description: IIS Status configuredMode: type: string description: Configured standby mode currentMode: type: string description: Current standby mode configuredLatency: type: integer description: DB latency for entering standby format: int32 nullable: true currentLatency: type: integer description: Current DB latency format: int32 nullable: true configuredWork: type: integer description: The configured number of work items pending before service becomes active format: int32 nullable: true currentWork: type: integer description: The current number of work items applicable for the service format: int32 nullable: true description: Platform Information description: Service status version: type: string description: Engine schema version description: Engine information security: - AccessToken: [] /vedsdk/SystemStatus/Version: get: tags: - System Status APIs summary: Get engine schema version description: "Returns the current schema version of the engine\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_GetVersion responses: '200': description: Engine schema version returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_VersionResponse' security: - AccessToken: [] /vedsdk/SystemStatus/Upgrade/Status: get: tags: - System Status APIs summary: Get upgrade status description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_IsAnUpgradeRunning responses: '200': description: Status returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_UpgradeStatusResponse' '403': description: No permissions to check status '500': description: Internal error security: - AccessToken: [] /vedsdk/SystemStatus/Upgrade/Summary: get: tags: - System Status APIs summary: Get upgrade summary description: "Returns an upgrade summary. Based on rights, details may be omitted for some users\r\n\r\n_Required scope:\ \ Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_UpgradeSummary responses: '200': description: Status returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_UpgradeSummaryResponse' '403': description: No permissions to check status '500': description: Internal error security: - AccessToken: [] /vedsdk/SystemStatus/Upgrade/Engine: get: tags: - System Status APIs summary: Get the upgrade status of one engine description: "Gets the upgrade status of one engine. Pass either the engine guid or id, but NOT both.\r\n\r\n_Required\ \ scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_Engine parameters: - name: guid in: query description: Engine GUID required: true schema: type: string - name: idString in: query description: Engine ID required: true schema: type: string - name: groupingId in: query description: Upgrade Grouping ID required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engine' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/SystemStatus/Upgrade/Engines: get: tags: - System Status APIs summary: Get all engine upgrade statuses description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_Engines parameters: - name: groupingId in: query description: Upgrade Grouping ID (defaulted to current upgrade) required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engines' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/SystemStatus/Upgrade/History: get: tags: - System Status APIs summary: Get upgrade history description: "Gets a list of upgrade Ids and which upgrades happened together.\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_SystemStatusRest_History responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_Obsolete_GroupingIdsResposne' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/BusStatus/getstatus: post: tags: - Platform APIs summary: Request bus participant status description: "\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_BusStatusRest_GetStatus requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_BusStatusWebResponse_getstatus' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/BusStatus/getmeshdnsname: post: tags: - Platform APIs summary: Get mesh partner DNS name description: "\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_BusStatusRest_GetMeshDnsName requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_BusStatusWebRequest_getmeshdnsname' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_BusStatusWebResponse_getmeshdnsname' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/BusStatus/setmeshdnsname: post: tags: - Platform APIs summary: Set mesh partner DNS name description: "\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_BusStatusRest_SetMeshDnsName requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_BusStatusWebRequest_setmeshdnsname' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_BusStatusWebResponse_setmeshdnsname' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/preferences/: get: tags: - User Preference APIs summary: Get user preferences description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_PreferenceRest_Get parameters: - name: Product in: query description: Product the preference belongs to schema: type: string - name: Category in: query description: Preference category schema: type: string - name: Name in: query description: Preference name schema: type: string responses: '200': description: Preferences Returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PreferenceWebResponse' '401': description: Invalid session content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PreferenceWebResponse' '400': description: Empty request or other error content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PreferenceWebResponse' security: - AccessToken: [] post: tags: - User Preference APIs summary: Add user preference description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_PreferenceRest_Add requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PreferenceWebRequest' required: true responses: '201': description: Preferences added '401': description: Invalid session '400': description: Empty request or other error security: - AccessToken: [] delete: tags: - User Preference APIs summary: Clear user preference description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_PreferenceRest_Clear parameters: - name: Product in: query description: Product the preference belongs to schema: type: string - name: Category in: query description: Preference category schema: type: string - name: Name in: query description: Preference name schema: type: string responses: '200': description: Preferences cleared '401': description: Invalid session '400': description: Failed to delete/clear preference security: - AccessToken: [] /vedsdk/recyclebin/getcontents: post: tags: - Recycle Bin APIs summary: Retrieve deleted items description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_GetContents requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_getcontents' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/getitem: post: tags: - Recycle Bin APIs summary: Retrieve deleted item description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_GetRecycledItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_getitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_getitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/getitemdetails: post: tags: - Recycle Bin APIs summary: Retrieve deleted item details description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_GetRecycledItemDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_getitemdetails' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_getitemdetails' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/restore: post: tags: - Recycle Bin APIs summary: Restore deleted item description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_Restore requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_restore' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_restore' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/purge: post: tags: - Recycle Bin APIs summary: Purge deleted item description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_Purge requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_purge' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_purge' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/empty: post: tags: - Recycle Bin APIs summary: Purge all items description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_Empty requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_empty' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/setconfiguration: post: tags: - Recycle Bin APIs summary: Set recyclebin configuration description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_SetConfiguration requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_setconfiguration' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_setconfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/getconfiguration: post: tags: - Recycle Bin APIs summary: Get recyclebin configuration description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_GetConfiguration requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_getconfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/purgetask: post: tags: - Recycle Bin APIs summary: Start/stop background purge description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_PurgeTask requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_purgetask' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_purgetask' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/recyclebin/deletiontask: post: tags: - Recycle Bin APIs summary: Start/stop deletion task description: "\r\n\r\n_Required scope: admin:recyclebin_" operationId: Venafi_Core_WebSDK_RecycleBinRest_DeletionTask requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebRequest_deletiontask' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RecycleBinWebResponse_deletiontask' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/grantrole: post: tags: - Access Management APIs summary: Assign a role description: "Assigns an OAuth role to an identity\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GrantRole requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_grantrole' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_grantrole' security: - AccessToken: [] /vedsdk/oauth/revokerole: post: tags: - Access Management APIs summary: Remove a role description: "Removes a role assignment from an identity\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_RevokeRole requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_revokerole' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_revokerole' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/listroles: post: tags: - Access Management APIs summary: Get assigned roles description: "Gets all identities with assigned roles\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_ListRoles requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_listroles' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getrole: post: tags: - Access Management APIs summary: Get own role description: "Returns the callers OAuth role\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetRole requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getrole' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getconfiguration: post: tags: - Access Management APIs summary: Get configuration description: "Gets the OAuth subsystem configuration\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetConfiguration requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getconfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/setconfiguration: post: tags: - Access Management APIs summary: Set configuration description: "Updates the OAuth subsystem configuration\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_SetConfiguration requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_setconfiguration' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_setconfiguration' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/createapplication: post: tags: - Access Management APIs summary: Create an application description: "Creates a new OAuth application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_CreateApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createapplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createapplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/enumerateapplications: post: tags: - Access Management APIs summary: Enumerate all applications description: "Enumerates all applications\r\n\r\n\r\nFor paging, use the _Start_ and _Count_ parameters. _Start_ indicates\ \ the number of applications to skip, _Count_ indicates the number of applications to return.\r\n\r\n\r\nOptionally,\ \ use _OrderBy_ and _Descending_ to determine how the applications are ordered.\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_EnumerateApplications requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumerateapplications' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumerateapplications' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getapplications: post: tags: - Access Management APIs summary: Search applications description: "Searches for OAuth applications based on provided criteria\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetApplications requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getapplications' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getapplications' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getapplication: post: tags: - Access Management APIs summary: Get an application description: "Returns a specific OAuth application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getapplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getapplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/updateapplication: post: tags: - Access Management APIs summary: Update an application description: "Updates an OAuth application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_UpdateApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updateapplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updateapplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/deleteapplication: post: tags: - Access Management APIs summary: Delete an application description: "Deletes an OAuth application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_DeleteApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleteapplication' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleteapplication' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getscopes: post: tags: - Access Management APIs summary: Get all scopes description: "Returns all scopes that are defined by applications\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetScopes requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getscopes' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getgrants: post: tags: - Access Management APIs summary: Get grants issued to an identity description: "Returns all grants issued to an identity, optionally filtering by application.\r\n\r\n\r\nWhen enumerating\ \ application grants, use the _Start_ and _Count_ parameters. _Start_ indicates the number of grants to skip, _Count_\ \ indicates the number of grants to return.\r\n\r\n\r\nOptionally, use _OrderBy_ and _Descending_ to determine in\ \ what order the grants are returned.\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetGrants requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getgrants' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getgrants' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/enumerategrants: post: tags: - Access Management APIs summary: Enumerate all application grants description: "Enumerate all grants giving access to the application specified with the _ApplicationId_ parameter.\r\n\ \r\n\r\nWhen enumerating application grants, use the _Start_ and _Count_ parameters. _Start_ indicates the number\ \ of grants to skip, _Count_ indicates the number of grants to return.\r\n\r\n\r\nOptionally, use _OrderBy_ and _Descending_\ \ to determine in what order the grants are returned.\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateGrants requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumerategrants' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumerategrants' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/revokegrants: post: tags: - Access Management APIs summary: Revoke grants description: "Revokes all grants issued for an application or for an identity.\r\n\r\n\r\nTo revoke grants for an application,\ \ specify the _ApplicationId_. To revoke grants for a user, specify the _GranteePrefixedUniversal_\r\n\r\n_Required\ \ scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_RevokeGrants requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_revokegrants' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_revokegrants' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/createrule: post: tags: - Access Management APIs summary: Create a rule description: "Creates a new rule\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_CreateRule requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createrule' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createrule' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getrules: post: tags: - Access Management APIs summary: Search rules description: "Finds rules that match all of the provided criteria\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetRules requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getrules' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getrules' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/enumeraterules: post: tags: - Access Management APIs summary: Enumerate all rules description: "Enumerates all rules\r\n\r\n\r\nFor paging, use the _Start_ and _Count_ parameters. _Start_ indicates\ \ the number of rules to skip, _Count_ indicates the number of rules to return.\r\n\r\n\r\nOptionally, use _OrderBy_\ \ and _Descending_ to determine how the rules are ordered.\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateRules requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumeraterules' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumeraterules' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/updaterule: post: tags: - Access Management APIs summary: Update a rule description: "Updates an existing rule\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_UpdateRule requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updaterule' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updaterule' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/deleterule: post: tags: - Access Management APIs summary: Delete a rule description: "Delete a rule\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_DeleteRule requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleterule' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleterule' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/deleterules: post: tags: - Access Management APIs summary: Deletes rules description: "Delete all rules for:\r\n\r\n* \r\nAn application. Specify \r\n_ApplicationId_* \r\nAn identity. Specify\ \ \r\n_TrusteePrefixedUniversal_* \r\nAn application and identity pair. Specify both \r\n_ApplicationId_* and \r\n\ _TrusteePrefixedUniversal_\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_DeleteRules requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deleterules' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deleterules' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/grantcount: post: tags: - Access Management APIs summary: Get grant count description: "Return the number of grants issued for an application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GrantCount requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_grantcount' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_grantcount' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/usercount: post: tags: - Access Management APIs summary: Get user count description: "Return the number of users holding grants issued for an application\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_UserCount requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_usercount' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_usercount' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/createjwtmapping: post: tags: - Access Management APIs summary: Create JWT mapping description: "Creates a new OAuth JWT mapping\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_CreateJwtMapping requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_createjwtmapping' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_createjwtmapping' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/enumeratejwtmappings: post: tags: - Access Management APIs summary: Enumerate JWT mappings description: "Enumerates all JWT mappings\r\n\r\n\r\nFor paging, use the _Start_ and _Count_ parameters. _Start_ indicates\ \ the number of mappings to skip, _Count_ indicates the number of mappings to return.\r\n\r\n\r\nOptionally, use _OrderBy_\ \ and _Descending_ to determine how the mappings are ordered.\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_EnumerateJwtMappings requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_enumeratejwtmappings' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_enumeratejwtmappings' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getjwtmappings: post: tags: - Access Management APIs summary: Search JWT mappings description: "Searches for JWT mappings matching provided criteria\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetJwtMappings requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getjwtmappings' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getjwtmappings' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/getjwtmapping: post: tags: - Access Management APIs summary: Get JWT mapping description: "Returns a specific JWT mapping\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_GetJwtMapping requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_getjwtmapping' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_getjwtmapping' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/updatejwtmapping: post: tags: - Access Management APIs summary: Update JWT mapping description: "Updates an existing JWT mapping\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_UpdateJwtMapping requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_updatejwtmapping' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_updatejwtmapping' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/oauth/deletejwtmapping: post: tags: - Access Management APIs summary: Delete JWT mapping description: "Deletes a JWT mapping\r\n\r\n_Required scope: admin_" operationId: Venafi_Core_WebSDK_OAuthRest_DeleteJwtMapping requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebRequest_deletejwtmapping' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_OAuthWebResponse_deletejwtmapping' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/createcounter: post: tags: - Statistics APIs summary: Create a counter description: "Creates a new statistics counter\r\n\r\n_Required scope: statistics:manage_" operationId: Venafi_Core_WebSDK_StatsRest_CreateCounter requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_createcounter' required: true responses: '200': description: Counter created content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_createcounter' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/deletecounter: post: tags: - Statistics APIs summary: Delete a counter description: "Delete a statistics counter\r\n\r\n_Required scope: statistics:delete_" operationId: Venafi_Core_WebSDK_StatsRest_DeleteCounter requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_deletecounter' required: true responses: '200': description: Counter deleted content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_deletecounter' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/renamecounter: post: tags: - Statistics APIs summary: Rename a counter description: "Renames a statistics counter\r\n\r\n_Required scope: statistics:manage_" operationId: Venafi_Core_WebSDK_StatsRest_RenameCounter requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_renamecounter' required: true responses: '200': description: Counter renamed content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_renamecounter' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/updatecounter: post: tags: - Statistics APIs summary: Update a counter description: "Updates a new statistics counter\r\n\r\n_Required scope: statistics:manage_" operationId: Venafi_Core_WebSDK_StatsRest_UpdateCounter requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_updatecounter' required: true responses: '200': description: Counter updated content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_updatecounter' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/getcounter: post: tags: - Statistics APIs summary: Get a counter description: "Retrieves a statistics counter\r\n\r\n_Required scope: statistics_" operationId: Venafi_Core_WebSDK_StatsRest_GetCounter requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_getcounter' required: true responses: '200': description: Counter returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_getcounter' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/getcounters: post: tags: - Statistics APIs summary: Get all counters description: "Retrieves all statistics counters.\r\n\r\nUse _StatsCode_ to only return counters of a particular family\r\ \n\r\n_Required scope: statistics_" operationId: Venafi_Core_WebSDK_StatsRest_GetCounters requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_getcounters' required: true responses: '200': description: Counters returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_getcounters' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/countercontainers: post: tags: - Statistics APIs summary: Get containers description: "Returns all containters\r\n\r\n_Required scope: statistics_" operationId: Venafi_Core_WebSDK_StatsRest_GetCounterContainers requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Containers created content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_countercontainers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/query: post: tags: - Statistics APIs summary: Get values description: "Retrieves statistics values for a counter\r\n\r\n_Required scope: statistics_" operationId: Venafi_Core_WebSDK_StatsRest_Query requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_query' required: true responses: '200': description: Statistics returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_query' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/stats/querytags: post: tags: - Statistics APIs summary: Search tags description: "Searches all tags that match the provided criteria\r\n\r\n_Required scope: statistics_" operationId: Venafi_Core_WebSDK_StatsRest_QueryTags requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebRequest_querytags' required: true responses: '200': description: Tags returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_StatsWebResponse_querytags' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/processingengines/: get: tags: - Processing Engines APIs summary: Get all processing engines description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_GetEngines responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EnginesResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/processingengines/folder/{folderGuid}: get: tags: - Processing Engines APIs summary: Get restrictions for a folder description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_GetFolderRestrictions responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FolderRestrictionsResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] put: tags: - Processing Engines APIs summary: Update restriction description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_SetFolderRestrictions parameters: - name: folderGuid in: query description: The guid of the folder schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_FolderRestrictionsRequest' required: true responses: '200': description: Restrictions Set '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] delete: tags: - Processing Engines APIs summary: Clear all restrictions on a folder description: "\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_Clear responses: '200': description: All Restrictions Deleted '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: folderGuid in: path description: The guid of the container to query engine restrictions for required: true schema: type: string /vedsdk/processingengines/engine/{engineGuid}: get: tags: - Processing Engines APIs summary: Get restrictions for an engine description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_GetEngineRestrictions responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EngineRestrictionsResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] post: tags: - Processing Engines APIs summary: Add a new restriction description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_AddEngineRestrictions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EngineRestrictionsRequest_engine__engineGuid_' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AddOperationResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: engineGuid in: path description: The guid of the engine to query restriction locations required: true schema: type: string /vedsdk/processingengines/folder/{folderGuid}/{engineGuid}: delete: tags: - Processing Engines APIs summary: Remove one engine from restriction on a folder description: "\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_ManagementPartitionRest_Remove responses: '200': description: Restrictions Deleted '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: folderGuid in: path description: The guid of the folder required: true schema: type: string - name: engineGuid in: path description: The guid of the engine to remove required: true schema: type: string /vedsdk/permissions/getprincipals: post: tags: - Permission APIs summary: Get trustees description: "\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetPrincipals requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest_getprincipals' required: true responses: '200': description: Permissions updated content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_getprincipals' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/getpermissions: post: tags: - Permission APIs summary: Get assigned permissions description: "\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetPermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest_getpermissions' required: true responses: '200': description: Assigned permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_getpermissions' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/geteffectivepermissions: post: tags: - Permission APIs summary: Get effective permissions description: "\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetEffectivePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest_geteffectivepermissions' required: true responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_geteffectivepermissions' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/grantpermissions: post: tags: - Permission APIs summary: Grant permissions description: "\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_GrantPermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest' required: true responses: '200': description: Permissions granted content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_grantpermissions' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/revokepermissions: post: tags: - Permission APIs summary: Revoke permissions description: "\r\n\r\n_Required scope: security:delete_" operationId: Venafi_Core_WebSDK_PermissionsRest_RevokePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest_revokepermissions' required: true responses: '200': description: Permissions revoked content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_revokepermissions' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/replacepermissions: post: tags: - Permission APIs summary: Update permissions description: "\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_ReplacePermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebRequest' required: true responses: '200': description: Permissions updated content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_replacepermissions' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/refresh: get: tags: - Permission APIs summary: Refresh permissions description: "\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_Refresh responses: '200': description: Permissions refreshed content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_PermissionsWebResponse_refresh' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/permissions/object/{guid}: get: tags: - Permission APIs summary: Gets object trustees description: "Returns a list of identities with permission to the object\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetPrincipalsForObject responses: '200': description: Principals returned content: application/json: schema: type: array items: type: string deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string /vedsdk/permissions/object/{guid}/local/{identity}: get: tags: - Permission APIs summary: Get assigned permissions of a local identity description: "Returns the assigned permissions of the local identity for the object\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetLocalPermissions responses: '200': description: Assigned permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string - name: identity in: path description: Universal identifier required: true schema: type: string /vedsdk/permissions/object/{guid}/local/{identity}/effective: get: tags: - Permission APIs summary: Get effective permissions of local identity description: "Returns the effective permissions of the local principal for the object\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetLocalEffectivePermissions responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EffectivePermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string - name: identity in: path description: Universal identifier required: true schema: type: string /vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}: get: tags: - Permission APIs summary: Get assigned permissions of an identity description: "Returns the assigned permissions of the principal\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetExtProviderPermissions responses: '200': description: Assigned permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EffectivePermissionsResponse' deprecated: true security: - AccessToken: [] delete: tags: - Permission APIs summary: Delete permissions description: "Deletes the permissions of the principal\r\n\r\n_Required scope: security:delete_" operationId: Venafi_Core_WebSDK_PermissionsRest_DeleteExtProviderPermission responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] post: tags: - Permission APIs summary: Add permissions description: "Adds permissions to an object\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_AddExtProviderPermission responses: '200': description: Permissions added content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] put: tags: - Permission APIs summary: Update permissions description: "Update permissions to an object\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_UpdateExtProviderPermission responses: '200': description: Permissions updated content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string - name: prefix in: path description: Provider prefix required: true schema: type: string - name: identity in: path description: Provider name required: true schema: type: string - name: principal in: path description: Universal identifier required: true schema: type: string /vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}/effective: get: tags: - Permission APIs summary: Get effective permissions of an identity description: "Returns the effective permissions of the principal\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetExtProviderEffectivePermissions responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EffectivePermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string - name: prefix in: path description: Provider prefix required: true schema: type: string - name: identity in: path description: Provider name required: true schema: type: string - name: principal in: path description: Universal identifier required: true schema: type: string /vedsdk/permissions/object/{guid}/myeffective: get: tags: - Permission APIs summary: Gets the effective permissions of the session's user for the given object. description: "Returns the effective permissions of the caller\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_PermissionsRest_GetMyEffectivePermissions responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_EffectivePermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string /vedsdk/permissions/object/{guid}/local/{principal}: delete: tags: - Permission APIs summary: Delete permissions description: "Deletes the permissions of the local principal\r\n\r\n_Required scope: security:delete_" operationId: Venafi_Core_WebSDK_PermissionsRest_DeleteLocalPermission responses: '200': description: Effective permissions returned content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] post: tags: - Permission APIs summary: Add permissions description: "Adds permissions to an object\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_AddLocalPermission responses: '200': description: Permissions added content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] put: tags: - Permission APIs summary: Update permissions description: "Update permissions to an object\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_PermissionsRest_UpdateLocalPermission responses: '200': description: Permissions updated content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_AssignedPermissionsResponse' deprecated: true security: - AccessToken: [] parameters: - name: guid in: path description: Object GUID required: true schema: type: string - name: principal in: path description: Universal identifier required: true schema: type: string /vedsdk/config/enumerate: post: tags: - Configuration APIs summary: Search objects description: "Returns a list of all subordinate Config objects for a specified folder\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsFilteredRecursive requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/enumerateall: post: tags: - Configuration APIs summary: Enumerate objects description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateAllObjects requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerateall' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerateall' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/enumeratepolicies: post: tags: - Configuration APIs summary: Enumerate policies description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_EnumeratePolicies requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumeratepolicies' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumeratepolicies' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/enumerateobjectsderivedfrom: post: tags: - Configuration APIs summary: Enumerate derived objects description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsDerivedFrom requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_enumerateobjectsderivedfrom' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_enumerateobjectsderivedfrom' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/create: post: tags: - Configuration APIs summary: Create an object description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_CreateObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_create' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/delete: post: tags: - Configuration APIs summary: Delete an object description: "\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_ConfigRest_DeleteObjectRecursive requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_delete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_delete' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/defaultdn: get: tags: - Configuration APIs summary: Gets the default DN description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_DefaultDN responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_defaultdn' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/find: post: tags: - Configuration APIs summary: Search an object by attribute description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_FindByAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_find' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_find' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/readall: post: tags: - Configuration APIs summary: Read all attributes description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ReadAllAttributes requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readall' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readall' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/findcontainers: post: tags: - Configuration APIs summary: Search containers description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_FindContainer requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findcontainers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findcontainers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/findobjectsofclass: post: tags: - Configuration APIs summary: Search objects of class description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_FindObjectsOfClass requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findobjectsofclass' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findobjectsofclass' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/findpolicy: post: tags: - Configuration APIs summary: Search policies description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_FindPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_findpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_findpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/gethighestrevision: post: tags: - Configuration APIs summary: Get highest container revision description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_GetHighestRevision requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_gethighestrevision' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_gethighestrevision' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/getrevision: post: tags: - Configuration APIs summary: Get object revision description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_GetRevision requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_getrevision' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_getrevision' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/getobjecttrustees: post: tags: - Configuration APIs summary: Get trustees of object description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_GetObjectTrustees requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_getobjecttrustees' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_getobjecttrustees' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/guidtodn: post: tags: - Configuration APIs summary: Convert GUID to DN description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_GUIDtoDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_guidtodn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_guidtodn' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/isvalid: post: tags: - Configuration APIs summary: Check if object exists description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_IsValid requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_isvalid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_isvalid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/mutateobject: post: tags: - Configuration APIs summary: Change object class description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_MutateObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_mutateobject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_mutateobject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/containableclasses: post: tags: - Configuration APIs summary: Enumerate container classes description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ContainableClasses requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_containableclasses' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_containableclasses' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/dntoguid: post: tags: - Configuration APIs summary: Convert DN to GUID description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_DNToGUID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_dntoguid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_dntoguid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/idinfo: post: tags: - Configuration APIs summary: Convert ID to DN description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_IDToDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_idinfo' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_idinfo' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/renameobject: post: tags: - Configuration APIs summary: Rename an object description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_RenameObject requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_renameobject' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_renameobject' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/clearattribute: post: tags: - Configuration APIs summary: Remove an attribute description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_ClearAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_clearattribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_clearattribute' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/clearpolicyattribute: post: tags: - Configuration APIs summary: Remove a policy attribute description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_ClearPolicyAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_clearpolicyattribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_clearpolicyattribute' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/read: post: tags: - Configuration APIs summary: Read an attribute description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_Read requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_read' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_read' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/countobjects: post: tags: - Configuration APIs summary: Return number of objects description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_CountObjects requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_countobjects' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigCountWebResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/readdn: post: tags: - Configuration APIs summary: Read a DN attribute description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ReadDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readdn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readdn' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/readdnreferences: post: tags: - Configuration APIs summary: Find all objects referencing a DN description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ReadDNReferences requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readdnreferences' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readdnreferences' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/readeffectivepolicy: post: tags: - Configuration APIs summary: Read effective attribute description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ReadEffectivePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readeffectivepolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readeffectivepolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/readpolicy: post: tags: - Configuration APIs summary: Read policy attribute description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_ConfigRest_ReadPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_readpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_readpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/addvalue: post: tags: - Configuration APIs summary: Add attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_AddValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_addvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_addvalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/adddnvalue: post: tags: - Configuration APIs summary: Add DN attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_AddDNValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_adddnvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_adddnvalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/addpolicyvalue: post: tags: - Configuration APIs summary: Add policy attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_AddPolicyValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_addpolicyvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_addpolicyvalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/removevalue: post: tags: - Configuration APIs summary: Remove attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_RemoveValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removevalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removevalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/removednvalue: post: tags: - Configuration APIs summary: Remove DN attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_RemoveDNValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removednvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removednvalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/removepolicyvalue: post: tags: - Configuration APIs summary: Remove policy attribute value description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_RemovePolicyValue requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_removepolicyvalue' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_removepolicyvalue' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/write: post: tags: - Configuration APIs summary: Write attributes description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_Write requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_write' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_write' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/writedn: post: tags: - Configuration APIs summary: Write DN attributes description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_WriteDN requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_writedn' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_writedn' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/config/writepolicy: post: tags: - Configuration APIs summary: Write policy attributes description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_ConfigRest_WritePolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebRequest_writepolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_writepolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/configschema/classes: post: tags: - Configuration APIs summary: Get class definitions description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Classes requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_classes' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_classes' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/configschema/class: post: tags: - Configuration APIs summary: Get a class definition description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Class requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_class' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_class' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/configschema/attributes: post: tags: - Configuration APIs summary: Get attributes description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Attribues requestBody: content: application/json: schema: type: object nullable: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_attributes' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/configschema/attribute: post: tags: - Configuration APIs summary: Get an attribute description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_ConfigSchemaRest_Attribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebSchemaRequest_attribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_ConfigWebResponse_attribute' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/X509CertificateStore/add: post: tags: - SecretStore APIs summary: Add an X509 certificate description: "This method validates the request and adds either a single certificate or a collection of certificates\ \ to the certificate store.\r\nIf a single certificate is added, the method logs the event and returns the vault ID\ \ of the added certificate.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Add requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_add' required: true responses: '200': description: The certificate was successfully added to the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_add' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: ' The user is not authorized to add the certificate to the vault.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: ' An error occurred on the server while adding the certificate to the vault.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/lookup: post: tags: - SecretStore APIs summary: Lookup X509 certificates description: "This method validates the request and looks up certificates in the certificate store based on the provided\ \ criteria.\r\nIf a certificate is provided, it looks up the vault ID of the certificate.\r\nIf an owner distinguished\ \ name (DN) is provided, it looks up all certificates owned by that DN.\r\nIf a name and value are provided, it looks\ \ up all certificates matching the name and value.\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Lookup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_lookup' required: true responses: '200': description: The certificates were successfully looked up in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_lookup' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to look up the certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while looking up the certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/lookupexpiring: post: tags: - SecretStore APIs summary: Lookup expiring X509 certificates description: "This method validates the request and looks up certificates in the certificate store that are expiring\ \ within the specified number of days.\r\nIf an owner distinguished name (DN) is provided, it looks up all certificates\ \ owned by that DN that are expiring within the specified number of days.\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_LookupExpiring requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_lookupexpiring' required: true responses: '200': description: The expiring certificates were successfully looked up in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_lookupexpiring' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to look up the expiring certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while looking up the expiring certificates in the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/remove: post: tags: - SecretStore APIs summary: Remove an X509 certificate description: "This method validates the request and removes a certificate from the certificate store.\r\nIf a vault\ \ ID is provided, it removes the certificate associated with that vault ID.\r\nIf a certificate is provided, it looks\ \ up the vault ID of the certificate and removes it.\r\nThe method logs the event if the certificate is successfully\ \ removed.\r\n\r\n_Required scope: restricted:delete_" operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Remove requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_remove' required: true responses: '200': description: The certificate was successfully removed from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_remove' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to remove the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while removing the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/X509CertificateStore/retrieve: post: tags: - SecretStore APIs summary: Retrieve an X509 certificate description: "This method validates the request and retrieves a certificate from the certificate store based on the\ \ provided vault ID.\r\nThe method also retrieves any associated names and values with the certificate.\r\nThe method\ \ logs the event if the certificate is successfully retrieved.\r\n\r\n_Required scope: certificate:manage_" operationId: Venafi_Core_WebSDK_X509CertificateStoreRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebRequest_retrieve' required: true responses: '200': description: The certificate was successfully retrieved from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse_retrieve' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '401': description: The user is not authorized to retrieve the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' '500': description: An error occurred on the server while retrieving the certificate from the vault. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_X509CertificateStoreWebResponse' security: - AccessToken: [] /vedsdk/Credentials/create: post: tags: - Credential APIs summary: Create a new credential description: "When adding Amazon credentials for _ADFS_ or _EC2AssignedRole_ sources, the credentials will be validated\ \ before storing them.\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_CredentialsRest_Create requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_create' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_create' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/Credentials/delete: post: tags: - Credential APIs summary: Delete a credential description: "\r\n\r\n_Required scope: security:delete_" operationId: Venafi_Core_WebSDK_CredentialsRest_Delete requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_delete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_delete' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/Credentials/enumerate: post: tags: - Credential APIs summary: Enumerate all credentials description: "\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_CredentialsRest_Enumerate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_enumerate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_enumerate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/Credentials/rename: post: tags: - Credential APIs summary: Rename a credential description: "\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_CredentialsRest_Rename requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_rename' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_rename' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/Credentials/retrieve: post: tags: - Credential APIs summary: Retrieve a credential description: "\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_CredentialsRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_retrieve' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_retrieve' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/Credentials/update: post: tags: - Credential APIs summary: Update a credential description: "\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_CredentialsRest_Update requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebRequest_update' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CredentialsWebResponse_update' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/crypto/availablekeys: get: tags: - Encryption APIs summary: List available keys description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_CryptoRest_AvailableKeys responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CryptoWebResponse_availablekeys' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/crypto/defaultkey: get: tags: - Encryption APIs summary: Get default key description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_CryptoRest_DefaultKey responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_CryptoWebResponse_defaultkey' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/browse: post: tags: - Identity APIs summary: Search Identity Entries description: "Returns information about individual identity, group identity, or distribution groups from a local or\ \ non-local \r\nprovider such as Active Directory. This method only searches for identities that are \r\ncontained\ \ in the identity provider of the authenticated user.\r\n\r\n\r\nFor AD or LDAP, use both the Filter and Limit parameters.\ \ As a best practice, if you expect one \r\nresult, specify Limit=2 to detect extraneous information. Default, when\ \ you omit this parameter:\r\n\r\n|Type|Recommendation|\r\n|---|---|\r\n|Active Directory|250 individual identities,\ \ group identities, or distribution groups|\r\n|LDAP|500 individual identities, group identities, or distribution\ \ groups|\r\n|Local|50 individual identities, group identities, or distribution groups|\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_Browse requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_browse' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_browse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/getassociatedentries: post: tags: - Identity APIs summary: Get Associated Identity Entries description: "Returns all associated identity groups and folders for a given identity entry.\r\n\r\n_Required scope:\ \ configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_GetAssociatedEntries requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_getassociatedentries' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_getassociatedentries' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/getmembers: post: tags: - Identity APIs summary: Get Group Members description: "Returns information about the members of an identity group. Members include owners. If you want group\ \ information about just one user, call POST Identity/GetMemberships.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_GetMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_getmembers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_getmembers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/getmemberships: post: tags: - Identity APIs summary: Get Groups description: "Returns information about a user's membership in an identity provider.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_GetMemberships requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_getmemberships' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_getmemberships' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/readattribute: post: tags: - Identity APIs summary: Read Attribute description: "Returns an array of attributes for the requested person or group's identity. The caller is not required\ \ to have any special permissions.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_ReadAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_readattribute' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_readattribute' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/validate: post: tags: - Identity APIs summary: Verify Identity Entry description: "Validates and returns missing information about an identity.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_Validate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_validate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_validate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/self: get: tags: - Identity APIs summary: Who Am I description: "Returns the Web SDK caller's self identity and all identities associated with the authenticated identity.\r\ \n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_IdentityRest_Self responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_self' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/SetPassword: post: tags: - Identity APIs summary: Change Password description: "Rotates a password for an identity. Password rotation for a group account is not supported. Password rotation\ \ \r\nfor any account that is managed by an external identity provider, such as Active Directory (AD) or \r\nLightweight\ \ Directory Access Protocol (LDAP) is not supported.\r\n\r\n_Required scope: security:manage_" operationId: Venafi_Core_WebSDK_IdentityRest_SetIdentityPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_SetPassword' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_SetPassword' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/addgroup: post: tags: - Identity APIs summary: Add Group description: "Adds a group to an identity provider. The group or team resides in the local provider. \r\nHowever, members,\ \ which are Trust Protection Foundation users or groups, can originate \r\nfrom a local, AD, or LDAP provider.\r\n\ \r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_IdentityRest_AddGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_addgroup' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_addgroup' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/renamegroup: put: tags: - Identity APIs summary: Rename Group description: "Renames a group in an identity provider.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_IdentityRest_RenameGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_renamegroup' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_renamegroup' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/group/{prefix}/{principal}: delete: tags: - Identity APIs summary: Delete Group description: "Deletes a group from an identity provider. The local group or team can contain users \r\nor other groups\ \ from local, AD, or LDAP identity providers. During deletion, Trust \r\nProtection Platform removes the local group\ \ and retains the identities.\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_IdentityRest_DeleteGroup responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_group__prefix___principal_' '400': description: Error Occurred content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_group__prefix___principal_' security: - AccessToken: [] parameters: - name: prefix in: path description: The identity provider prefix required: true schema: type: string - name: principal in: path description: The universal identifier of the identity required: true schema: type: string /vedsdk/identity/addgroupmembers: put: tags: - Identity APIs summary: Add Group Members description: "Assigns members to a group in an identity provider. The group resides in the local provider. However,\ \ members, \r\nwhich are Trust Protection Foundation users or groups, can originate from a local, AD, or LDAP provider.\r\ \n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_IdentityRest_AddGroupMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_addgroupmembers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_addgroupmembers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/identity/removegroupmembers: put: tags: - Identity APIs summary: Remove Group Members description: "Removes a member from a group in an identity provider. Even though the user or group is removed from the\ \ local group, Trust Protection Platform retains the identities.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_IdentityRest_RemoveGroupMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebRequest_removegroupmembers' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_IdentityWebResponse_removegroupmembers' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/defineitem: post: tags: - Metadata APIs summary: Create a Custom Field description: "Creates a new Custom Field. The Custom Field appears in the User Interface (UI).\r\n\r\n_Required scope:\ \ configuration:manage_" operationId: Venafi_Core_WebSDK_MetadataRest_DefineItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_defineitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_defineitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/updateitem: post: tags: - Metadata APIs summary: Update a Custom Field description: "Updates settings that control a Custom Field, such as default and required user input values. Either the\ \ _Item_ or _Update_ property must be provided, but **not** both.\r\n\r\n**NOTE** You cannot update `SchemaAttribute`,\ \ `DN`, `GUID`, `Name` and `Type`. These properties are read-only after creation of the Custom Field. If you attempt\ \ to change them, the request will fail.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_MetadataRest_UpdateItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_updateitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_updateitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/undefineitem: post: tags: - Metadata APIs summary: Delete a Custom Field description: "Removes an existing Custom Field. The caller must have Delete permission to the Custom Field object.\r\ \n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_MetadataRest_UndefineItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_undefineitem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_undefineitem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/items: get: tags: - Metadata APIs summary: Get all Custom Fields description: "Returns every Custom Field definition.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_GetAllItems responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_items' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/finditem: post: tags: - Metadata APIs summary: Find a Custom Field description: "Finds a Custom Field, searching by Name or UI label.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_FindItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_finditem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_finditem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/loaditem: post: tags: - Metadata APIs summary: Get Custom Field definition description: "Returns a Custom Field definition. Unlike `POST metadata/loaditemguid`, this returns the full Custom Field\ \ definition.\r\n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_MetadataRest_LoadItem requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_loaditem' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_loaditem' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/loaditemguid: post: tags: - Metadata APIs summary: Get Custom Field GUID description: "Returns an Custom Field GUID. Unlike `POST metadata/loaditem`, this returns only the Custom Field GUID.\r\ \n\r\n_Required scope: configuration_" operationId: Venafi_Core_WebSDK_MetadataRest_LoadItemGuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_loaditemguid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_loaditemguid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/get: post: tags: - Metadata APIs summary: Read values description: "Returns the values for all Custom Fields that apply to a particular object. The caller must have Read\ \ permission to the DN of a certificate or device in the request.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_Get requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_get' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_get' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/readeffectivevalues: post: tags: - Metadata APIs summary: Read effective value description: "Returns the effective value of a Custom Field for a particular object.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_ReadEffective requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_readeffectivevalues' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_readeffectivevalues' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/readpolicy: post: tags: - Metadata APIs summary: Read policy value description: "Returns a Custom Field value that has been applied to a policy for inheritance by objects of a specific\ \ type.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_ReadPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_readpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_readpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/set: post: tags: - Metadata APIs summary: Write value description: "Assigns a Custom Field value to an object.\r\n\r\nThe caller must have Write permission to the DN of a\ \ certificate or device DN in the request\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_Set requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_set' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_set' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/setpolicy: post: tags: - Metadata APIs summary: Write policy value description: "Assigns a Custom Field value to a policy.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Core_WebSDK_MetadataRest_SetPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_setpolicy' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_setpolicy' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/find: post: tags: - Metadata APIs summary: Search objects description: "Returns all objects with a value stored for a Custom Field. At least one of _ItemGuid_ or _Value_ must\ \ be provided.\"\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_Find requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_find' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_find' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitems: post: tags: - Metadata APIs summary: Get applicable Custom Fields description: "Returns an array of Custom Field attributes that apply to the specified object. Unlike `POST metadata/getitemguids`,\ \ this returns the full Custom Field definitions.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_GetItems requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitems' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitems' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitemguids: post: tags: - Metadata APIs summary: Get applicable Custom Field GUIDs description: "Returns an array of Custom Field GUIDs for that apply to the specified object. Unlike `POST metadata/getitems`,\ \ this returns only the GUID of the each Custom Field.\r\n\r\n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_GetItemGuids requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitemguids' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitemguids' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getpolicyitems: post: tags: - Metadata APIs summary: Get allowed Custom Fields description: "Returns all Custom Fields that are applicable to children of the specified container\r\n\r\n_Required\ \ scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_GetPolicyItems requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getpolicyitems' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getpolicyitems' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/metadata/getitemsforclass: post: tags: - Metadata APIs summary: Get Custom Fields for class description: "Returns an array of Custom Fields and their attributes that apply to the specified object class.\r\n\r\ \n_Required scope: :manage_" operationId: Venafi_Core_WebSDK_MetadataRest_GetItemsForClass requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebRequest_getitemsforclass' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_MetadataWebResponse_getitemsforclass' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/rights/grantsystemrole: post: tags: - Access Management APIs summary: Grant a system role to a user or group description: "Grants one of the following system roles [to a user or group]:\r\n\"Owner|Master\",\"Auditor\",\"AccessAdmin\"\ ,\"RecycleBinAdmin\",\"SchemaAdmin\"\r\n\r\nNote: Owner|Master refers to the Master Admin role.\r\n\r\nThe caller\ \ must have the Security scope with Manage restriction.\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_RightsRest_GrantSystemRole requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RightsWebRequest_grantsystemrole' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RightsWebResponse_grantsystemrole' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/rights/revokesystemrole: post: tags: - Access Management APIs summary: Revoke a system role from a user or group description: "Revokes one of the following system roles [from a user or group] :\r\n\"Owner|Master\",\"Auditor\",\"\ AccessAdmin\",\"RecycleBinAdmin\",\"SchemaAdmin\"\r\n\r\nNote: Owner|Master refers to the Master Admin role.\r\n\r\ \nThe caller must have the Security scope with Manage restriction.\r\nNote: You cannot revoke Master Admin rights\ \ from your own account.\r\n\r\n_Required scope: security_" operationId: Venafi_Core_WebSDK_RightsRest_RevokeSystemRole requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RightsWebRequest_revokesystemrole' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_RightsWebResponse_revokesystemrole' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/add: post: tags: - SecretStore APIs summary: Add a secret description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Add requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_add' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_add' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/availablenamespaces: get: tags: - SecretStore APIs summary: List available namespace description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_AvailableNamespaces responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_availablenamespaces' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/associate: post: tags: - SecretStore APIs summary: Add an association description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Associate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_associate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_associate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/dissociate: post: tags: - SecretStore APIs summary: Remove an association description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Dissociate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_dissociate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_dissociate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/encryptionkeysinuse: get: tags: - SecretStore APIs summary: Get encryption keys in use description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_EncryptionKeysInUse responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_encryptionkeysinuse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookup: get: tags: - SecretStore APIs summary: Search a secret description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Lookup responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookup' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookupbyvaulttype: post: tags: - SecretStore APIs summary: Search by vault type description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupByVaultType requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyvaulttype' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyvaulttype' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookupbyassociation: post: tags: - SecretStore APIs summary: Search by association description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAssociation requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyassociation' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyassociation' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookupassociationbyvaultid: post: tags: - SecretStore APIs summary: Lookup association by vault id description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAssociationByVaultID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupassociationbyvaultid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupassociationbyvaultid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookupallassociationsbyvaultid: post: tags: - SecretStore APIs summary: Get all associations by vault id description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupAllAssociationsByVaultID requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupallassociationsbyvaultid' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupallassociationsbyvaultid' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/mutate: post: tags: - SecretStore APIs summary: Change secret type description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Mutate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_mutate' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_mutate' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/lookupbyowner: post: tags: - SecretStore APIs summary: Search by owner description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_LookupByOwner requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_lookupbyowner' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_lookupbyowner' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/owneradd: post: tags: - SecretStore APIs summary: Add an owner description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_OwnerAdd requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_owneradd' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_owneradd' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/ownerdelete: post: tags: - SecretStore APIs summary: Delete an owner description: "\r\n\r\n_Required scope: restricted:delete_" operationId: Venafi_Core_WebSDK_SecretStoreRest_OwnerDelete requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_ownerdelete' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_ownerdelete' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/ownerlookup: post: tags: - SecretStore APIs summary: Get owners of a secret description: "\r\n\r\n_Required scope: restricted_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Ownerlookup requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_ownerlookup' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_ownerlookup' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/retrieve: post: tags: - SecretStore APIs summary: Retrieve a secret description: "\r\n\r\n_Required scope: restricted:manage_" operationId: Venafi_Core_WebSDK_SecretStoreRest_Retrieve requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebRequest_retrieve' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_retrieve' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/secretstore/rotatekey/{vaultid}: get: tags: - SecretStore APIs summary: Rotate a key description: "\r\n\r\n_Required scope: admin:rotate_" operationId: Venafi_Core_WebSDK_SecretStoreRest_RotateKey parameters: - name: newkeyname in: query description: The name of the new key required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_SecretStoreWebResponse_rotatekey__vaultid_' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] parameters: - name: vaultid in: path description: The Vault Id of the entry to rotate the key required: true schema: type: string /vedsdk/workflow/ticket/create: post: tags: - Legacy Workflow APIs summary: Create a workflow ticket description: "Initiates a ticket to proceed through an existing workflow and act on a Policy tree object.\r\n\r\n_Required\ \ scope: configuration:manage_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketCreate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_create' required: true responses: '200': description: The workflow ticket was successfully created. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to create the workflow ticket. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: An error occurred on the server while creating the workflow ticket. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/delete: post: tags: - Legacy Workflow APIs summary: Remove a workflow ticket description: "Permanently removes an existing workflow ticket from the platform.\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketDelete requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_delete' required: true responses: '200': description: The workflow ticket was successfully deleted. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to delete the workflow ticket. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: An error occurred on the server while deleting the workflow ticket. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/details: post: tags: - Legacy Workflow APIs summary: Get workflow ticket details description: "Returns the status, list of approvers, and other details about a workflow ticket.\r\n\r\n_Required scope:\ \ Any_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_details' required: true responses: '200': description: The workflow ticket details were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to retrieve the workflow ticket details. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: An error occurred on the server while retrieving the workflow ticket details. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/enumerate: post: tags: - Legacy Workflow APIs summary: Enumerate workflow tickets description: "Returns the GUIDs of all workflow tickets associated with the object and user. If no Object DN is provided,\ \ it will use the current session ID.\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketEnumerate requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_enumerate' required: true responses: '200': description: The workflow ticket GUIDs were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to retrieve the workflow ticket GUIDs. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: An error occurred on the server while retrieving the workflow ticket GUIDs. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/exists: post: tags: - Legacy Workflow APIs summary: Verify workflow ticket exists description: "Verifies whether a workflow ticket exists.\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketExists requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_exists' required: true responses: '200': description: The workflow ticket existence was successfully verified. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to verify the workflow ticket existence. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: ' An error occurred on the server while verifying the workflow ticket existence.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/status: post: tags: - Legacy Workflow APIs summary: Get workflow ticket status description: "Retrieves the status string for an existing workflow ticket.\r\n\r\n_Required scope: Any_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_status' required: true responses: '200': description: The workflow ticket status was successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to retrieve the workflow ticket status. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: ' An error occurred on the server while retrieving the workflow ticket status.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/workflow/ticket/updatestatus: post: tags: - Legacy Workflow APIs summary: Update workflow ticket status description: "Updates the status of a workflow ticket as approved or rejected and provides the option to set a schedule\ \ for approved tickets.\r\n\r\n_Required scope: :approve_" operationId: Venafi_Core_WebSDK_WorkflowTicketRest_TicketUpdateStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebRequest_ticket_updatestatus' required: true responses: '200': description: The workflow ticket status was successfully updated. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '400': description: The request was invalid, possibly due to missing required properties. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '401': description: The user is not authorized to update the workflow ticket status. content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' '500': description: ' An error occurred on the server while updating the workflow ticket status.' content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_WorkflowTicketsWebResponse' security: - AccessToken: [] /vedsdk/log/evaluatemacro: post: tags: - Log APIs summary: Perform a macro translation description: "\r\n\r\n_Required scope: configuration_" operationId: Venafi_WebSDK_Log_LogRest_EvaluateMacro requestBody: content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_LogWebRequest_evaluatemacro' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Core_WebSDK_LogWebResponse_evaluatemacro' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/log/adaptableinfo: get: tags: - Log APIs summary: Retrieve information about available Log Adaptable scripts description: "\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_WebSDK_Log_LogRest_AdaptableInformation responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebSDK_Log_LogAdaptableResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/ssh/rules: get: tags: - SSH Management APIs summary: Search key authorization rules description: "Returns key authorization rules and the total number of key authorization rules that match the specified\ \ search filters.\r\n\r\n_Required scope: ssh_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetAuthRules parameters: - name: offset in: query description: Number of rules to skip from the beginning. schema: type: string - name: limit in: query description: Number of rules to take. schema: type: string - name: accounts in: query description: Comma separated list of accounts. schema: type: string - name: hosts in: query description: Comma separated list of hosts. schema: type: string - name: serverips in: query description: Comma separated list of server ip addresses. schema: type: string - name: keyalgorithms in: query description: Comma separated list of key algorithms. schema: type: string - name: keyfingerprints in: query description: Comma separated list of key fingerprints. schema: type: string responses: '200': description: The response body contains the list of key authorization rules that match the specified search filters. content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_AuthRulesResponse' '500': description: An unexpected error occurred during the key authorization rules search process. The ErrorDetails property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_AuthRulesResponse' '400': description: The request was invalid due to incorrect parameters (e.g., invalid key algorithm). The ErrorDetails property contains details about the failure. content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_AuthRulesResponse' security: - AccessToken: [] /vedsdk/ssh/TestDeviceConnection: post: tags: - SSH Management APIs summary: Returns connection status for provided devices description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_TestDeviceConnection requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IList_1_Ssh_WebSDK_DataContract_TestDeviceConnectionResult_' /vedsdk/ssh/ImportKeyUsageData: post: tags: - SSH Management APIs summary: Imports key usage from a Unix or Linux host syslog. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ImportKeyUsageData requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyUsageData' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/ssh/KeyUsage: post: tags: - SSH Management APIs summary: Finds all key usage records matching the specified filtering criteria. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetKeyUsages requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest_KeyUsage' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshKeyUsageData_' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] /vedsdk/ssh/RemoveKey: post: tags: - SSH Management APIs summary: Marks a key for deletion. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_Remove requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/CancelKeyOperation: post: tags: - SSH Management APIs summary: Cancels any running key operation. Can also rollback a key to its original state. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_CancelKeyOperation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/RetryKeyOperation: post: tags: - SSH Management APIs summary: Retries any failing operation (addition, removal, editing) on specified key. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_RetryKeyOperation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/Rotate: post: tags: - SSH Management APIs summary: Starts Synchronous Rotation of a specific keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_StartRotation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/RotateNonBlocking: post: tags: - SSH Management APIs summary: Submits Rotation request of specific keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_StartRotationNonBlocking requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/RollbackNonBlocking: post: tags: - SSH Management APIs summary: Submits Rollback request of specific keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_StartRollbackNonBlocking requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/CancelRotation: post: tags: - SSH Management APIs summary: Cancels rotation of the specified keyset if it is running, or rolls back the keyset to the previous version if the rotation has finished or failed. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_CancelRotation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/RetryRotation: post: tags: - SSH Management APIs summary: Retries rotation of specified keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_RetryRotation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/EditKeyOptions: post: tags: - SSH Management APIs summary: Changes Source Restrictions, and Forced commands in an authorized keys file. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_EditKeyOptions requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyOptionsWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/EditSelfServiceAuthorizedKey: post: tags: - SSH Management APIs summary: Changes location, notes, Source Restrictions, and Forced commands in an selfservice authorized keys. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_EditSelfServiceAuthorizedKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_EditSelfServiceAuthorizedKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/AddSelfServicePrivateKey: post: tags: - SSH Management APIs summary: Assigns an existing keyset to a policy folder. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddSelfServicePrivateKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddSelfServicePrivateKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddSelfServiceKeyWebResponse' /vedsdk/ssh/AddSelfServiceAuthorizedKey: post: tags: - SSH Management APIs summary: Add an authorization key to a keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddSelfServiceAuthorizedKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddSelfServiceAuthorizedKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddSelfServiceKeyWebResponse' /vedsdk/ssh/ConfirmSelfServiceKeyInstallation: post: tags: - SSH Management APIs summary: Verifies that a user manually installed a private key. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ConfirmSelfServiceKeyInstallation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeySetWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/MoveKeysetsToPolicy: post: tags: - SSH Management APIs summary: Moves a list of keysets to a policy folder. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_MoveKeysetsToPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeysetToPolicyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/ExportSelfServiceAuthorizedKey: post: tags: - SSH Management APIs summary: Downloads an authorized key. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ExportSelfServiceAuthorizedKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_ExportSelfServiceKeyRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_ExportSelfServiceKeyResponse' /vedsdk/ssh/ExportSelfServicePrivateKey: post: tags: - SSH Management APIs summary: Downloads a private key. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ExportSelfServicePrivateKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_ExportSelfServicePrivateKeyRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_ExportSelfServiceKeyResponse' /vedsdk/ssh/SkipKeyRotation: post: tags: - SSH Management APIs summary: Skip key rotation. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_SkipKeyRotation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_KeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/AddUserPrivateKey: post: tags: - SSH Management APIs summary: Installs a new user private key on a device. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddUserPrivateKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddUserPrivateKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddUserPrivateKeyWebResponse' /vedsdk/ssh/AddHostPrivateKey: post: tags: - SSH Management APIs summary: Creates and installs a new private key on a host device. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddHostPrivateKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddHostPrivateKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddHostPrivateKeyWebResponse' /vedsdk/ssh/AddAuthorizedKey: post: tags: - SSH Management APIs summary: Creates an Open SSH Authorized key for provisioning to a device. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddAuthorizedKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddAuthorizedKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddKeyWebResponse' /vedsdk/ssh/AddKnownHostKey: post: tags: - SSH Management APIs summary: Creates a public key for a host. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_AddKnownHostKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AddKnownHostKeyWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_AddKeyWebResponse' /vedsdk/ssh/ImportAuthorizedKey: post: tags: - SSH Management APIs summary: Adds or reuses a Base64 public key for a device. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ImportAuthorizedKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_AuthorizedKeyData' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_ImportResponse' /vedsdk/ssh/ImportPrivateKey: post: tags: - SSH Management APIs summary: Adds or reuses a Base64 private key for a device. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ImportPrivateKey requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_PrivateKeyData' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_ImportResponse' /vedsdk/ssh/ChangePrivateKeyPassphrase: post: tags: - SSH Management APIs summary: Changes the private key passphrase for a keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ChangePrivateKeyPassphrase requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_ChangePrivateKeyPassphraseRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/SetUnmatchedKeysetPassphrase: post: tags: - SSH Management APIs summary: Sets the passphrase on a keyset that is missing the encrypted private key. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_SetUnmatchedKeysetPasshrase requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/DeleteUnmatchedKeyset: post: tags: - SSH Management APIs summary: Deletes an unmatched keyset that is missing the encrypted private key passphrase and .pub file extension. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_DeleteUnmatchedKeyset requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetDeleteRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/KeyDetails: post: tags: - SSH Management APIs summary: Returns detailed key data. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetKeyDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/IList_1_Ssh_WebSDK_DataContract_KeyData_' /vedsdk/ssh/Devices: post: tags: - SSH Management APIs summary: Finds devices in the Policy tree that match the filtering criteria. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetDevices requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshDeviceData_' /vedsdk/ssh/KeysetDetails: get: tags: - SSH Management APIs summary: Provides information about every device that shares the same keyset. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetKeysetDetail parameters: - name: KeysetId in: query schema: type: string - name: LoadKeyData in: query schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeysetData' post: tags: - SSH Management APIs summary: Returns private and public key pairs that identify details about a device description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_GetKeysetDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_KeysetData_' /vedsdk/ssh/ApproveKeyOperation: post: tags: - SSH Management APIs summary: Approves any key operation that has a Pending Approval status in a workflow. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_ApproveKeyOperation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_WorkflowKeyOperationRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/ssh/RejectKeyOperation: post: tags: - SSH Management APIs summary: Rejects any key operation that has a Pending Approval status in a workflow. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_Ssh_WebSDK_SshRestService_RejectKeyOperation requestBody: content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_Requests_WorkflowKeyOperationRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_SshWebResponse' /vedsdk/sshcertificates/request: post: tags: - SSH Certificate APIs summary: Requests a new SSH certificate description: "This endpoint can be used to request an SSH certificate based on the supplied parameters.\r\n\r\nPrerequisites:\r\ \nRequires setup. A master administrator or security team creates a SSH Certificate Issuance Template.\r\nTo see defaults\ \ and options, open the template from Configuration. For more information, see the SSH Key Discovery and Remediation\ \ Guide.\r\n\r\nPermissions:\r\n- The caller must have View and Create permission to the CA template (CADN).\r\n-\ \ If the caller is passing CADN and PolicyDN: The caller must have View and Create permission to both the Certificate\ \ Issuance Template (CADN) and the Policy folder (PolicyDN) for the SSH certificate.\r\n\r\n_Required scope: Any_" operationId: Venafi_SshCertificate_WebSDK_SshCertificateRestService_RequestCertificate requestBody: content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_Requests_RequestNewCertificateWebRequest' required: true responses: '200': description: SSH certificate has been successfully requested content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_RequestCertificateResponse' '400': description: Invalid request '401': description: Unauthorized security: - AccessToken: [] /vedsdk/sshcertificates/retrieve: post: tags: - SSH Certificate APIs summary: Returns the available certificate data and optional private key information for an enrolled SSH certificate. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_SshCertificate_WebSDK_SshCertificateRestService_RetrieveCertificate requestBody: content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_Requests_RetrieveCertificateWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_RetrieveCertificateResponse' /vedsdk/sshcertificates/template/available: get: tags: - SSH Certificate APIs summary: Returns a list of SSH CA templates the current user can request certificates from. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_SshCertificate_WebSDK_SshCertificateRestService_GetAvailableTemplates responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/List_1_SshCertificate_WebSDK_DataContract_AvailableTemplateResponse_' /vedsdk/sshcertificates/template/retrieve: post: tags: - SSH Certificate APIs summary: Returns information about an SSH CA template. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_SshCertificate_WebSDK_SshCertificateRestService_RetrieveTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_Requests_RetrieveTemplateWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_RetrieveTemplateResponse' /vedsdk/sshcertificates/CaKeyPair/create: post: tags: - SSH Certificate APIs summary: Create new CA Keypair. description: "\r\n\r\n_Required scope: Any_" operationId: Venafi_SshCertificate_WebSDK_SshCertificateRestService_CreateNewCAKeypair requestBody: content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_Requests_CreateNewCAKeypairWebRequest' required: true responses: '200': description: SSH certificate has been successfully requested content: application/json: schema: $ref: '#/components/schemas/SshCertificate_WebSDK_DataContract_CreateCaKeyPairResponse' '400': description: Invalid request '401': description: Unauthorized security: - AccessToken: [] /vedsdk/teams/: post: tags: - Teams APIs summary: Create a team description: "Adds a team to an identity provider. Members specified for the team will be added.\r\n\r\n_Required scope:\ \ configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_CreateTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest__' required: true responses: '200': description: The team was created successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: ' The request is invalid or required parameters are missing.' content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/teams/{prefix}/{principal}: get: tags: - Teams APIs summary: Get a team description: "Retrieves the details of a specified team, including its members, owners, products, assets, and description.\r\ \n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_GetTeam responses: '200': description: The team details were retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] put: tags: - Teams APIs summary: Update a team description: "This API updates the details of an existing team, including its members, owners, products, assets, and\ \ description.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_UpdateTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest' required: true responses: '200': description: The team details were updated successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] delete: tags: - Teams APIs summary: Delete a team description: "The team was deleted successfully.\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Teams_WebSDK_TeamsRest_DeleteTeam responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] parameters: - name: prefix in: path description: The identity provider prefix. required: true schema: type: string - name: principal in: path description: The Universally Unique Identifier (UUID) of the user or group identity. required: true schema: type: string /vedsdk/teams/addteammembers: put: tags: - Teams APIs summary: Add members to a team description: "Adds members to an existing team.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_AddTeamMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest_addteammembers' required: true responses: '200': description: The members were added to the team successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/teams/removeteammembers: put: tags: - Teams APIs summary: Remove members from a team description: "Removes members from an existing team.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_RemoveTeamMembers requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest_removeteammembers' required: true responses: '200': description: The members were removed from the team successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/teams/addteamowners: put: tags: - Teams APIs summary: Add owners to a team description: "Adds owners to an existing team.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_AddTeamOwners requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest_addteamowners' required: true responses: '200': description: The owners were added to the team successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/teams/demoteteamowners: put: tags: - Teams APIs summary: Demote team owners description: "Demotes owners in an existing team.\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_DemoteTeamOwners requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest_demoteteamowners' required: true responses: '200': description: The owners were demoted in the team successfully. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: The request is invalid or required parameters are missing. content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/teams/renameteam: put: tags: - Teams APIs summary: Rename a team description: "Renames a team and updates team assets with new team name\r\n\r\n_Required scope: configuration:manage_" operationId: Venafi_Teams_WebSDK_TeamsRest_RenameTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebRequest_renameteam' required: true responses: '200': description: ' The team was renamed successfully.' content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' '400': description: ' The request is invalid or required parameters are missing.' content: application/json: schema: $ref: '#/components/schemas/Teams_WebSDK_TeamWebResponse' security: - AccessToken: [] /vedsdk/platform/delete: post: tags: - Platform APIs summary: Delete an engine description: "\r\n\r\n_Required scope: configuration:delete_" operationId: Venafi_Platform_WebSDK_PlatformRest_DeletePlatform requestBody: content: application/json: schema: $ref: '#/components/schemas/Platform_WebSDK_PlatformWebRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Platform_WebSDK_PlatformWebResponse' '403': description: ' The API requires a scope not granted to the provided access token ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '400': description: ' Missing or invalid request property. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' '401': description: ' A valid access token is required. ' content: application/json: schema: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthError' security: - AccessToken: [] components: schemas: Core_IdentityType: title: Enumeration defining Identity type objects enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 type: integer description: "\r\n\r\n**0**: **Undefined** \r\nUndefined\r\n\r\n**1**: **User** \r\nUser object\r\n\r\n**2**: **Group**\ \ \r\nGroup object\r\n\r\n**4**: **Container** \r\nContainer of users and groups\r\n\r\n**8**: **DistributionList**\ \ \r\nDistribution List\r\n\r\n**16**: **Machine** \r\nMachine\r\n\r\n**32**: **Provider** \r\nThe Identity Provider\r\ \n\r\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\r\n" format: int32 Core_IdentityEntry_EntryState: title: Enumeration indicating the state of an IdentityEntry enum: - 0 - 1 - 2 - 4 - 8 type: integer description: "\r\n\r\n**0**: **Normal** \r\nNo special state associated with the entry\r\n\r\n**1**: **Disabled** \ \ \r\nThe identity has been disabled\r\n\r\n**2**: **LockedOut** \r\nThe identity has been locked out\r\n\r\n**4**:\ \ **Deleted** \r\nThe identity has been deleted\r\n\r\n**8**: **Unverifiable** \r\nThe identity could not be verified\ \ with a provider\r\n\r\n_This field is a flag and the actual value will be the sum of all applicable enumeration\ \ values._\r\n" format: int32 Nullable_1_Core_Cryptography_SubjectAltNameType_: title: Enumeration of possible SAN types enum: - 2 - 1 - 1 - 7 - 6 - 0 type: integer description: "\r\n\r\n**2**: **DNS** \r\nSpecifies the SubjestAltName is a DNS entry\r\n\r\n**1**: **RFC822** \r\n\ Specifies the SubjestAltName is an Email address\r\n\r\n**1**: **Email** \r\nSpecifies the SubjestAltName is an Email\ \ address\r\n\r\n**7**: **IPAddress** \r\nSpecifies the SubjestAltName is an IP Address\r\n\r\n**6**: **URI** \r\ \nSpecifies the SubjestAltName is a Uniform Resource Identifier\r\n\r\n**0**: **OtherName** \r\nSpecifies the Subject\ \ AltName is an Other Name.\r\n" format: int32 nullable: true Nullable_1_Core_Revocation_RevocationReason_: title: Enumeration for revocation status enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: "\r\n\r\n**0**: **Unspecified** \r\nNo reason given (RFC)\r\nnone\r\n\r\n**1**: **KeyCompromise** \r\n\ The key was compromised (RFC)\r\nAn issued certificate's private key was compromised\r\n\r\n**2**: **CACompromise**\ \ \r\nThe Certificate Authority was compromised (RFC)\r\nThe CA's private key was compromised\r\n\r\n**3**: **AffiliationChanged**\ \ \r\nThe certificates affiliation has changed (RFC)\r\nUser is no longer associated with the organization for which\ \ a certificate was issued\r\n\r\n**4**: **Superseded** \r\nThe certificate has bee superseded (RFC)\r\nThe certificate\ \ has been superseded\r\n\r\n**5**: **CessationOfOperation** \r\nThe certificate is no longer being used (RfC)\r\n\ The certificate is no longer valid\r\n\r\n**6**: **CertificateHold** \r\nThe certificate is being placed in stasis\ \ (RFC)\r\n\r\n**7**: **Reserved** \r\nUnknown reason for the certificate to have been revoked (RFC)\r\n\r\n**8**:\ \ **RemoveFromCRL** \r\nThe certificate is no long being held (RFC)\r\n\r\n**9**: **PrivilegeWithdrawn** \r\nThe\ \ certificate's privilege has been withdrawn (RFC)\r\n\r\n**10**: **AACompromise** \r\nThe AA of the certificate\ \ was compromised (RFC)\r\n" format: int32 nullable: true CodeSigning_SignRight: title: Enumeration stating what permissions the user has enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 type: integer description: "\r\n\r\n**0**: **None** \r\nNo rights\r\n\r\n**1**: **Admin** \r\nAdministrator (full) rights\r\n\r\n\ **2**: **Use** \r\nThe right to use a key for signing\r\n\r\n**4**: **Audit** \r\nThe right to audit a project\r\ \n\r\n**8**: **Owner** \r\nThe right indicating ownership of a project\r\n\r\n**16**: **ProjectApproval** \r\nThe\ \ right to approve draft projects\r\n\r\n**32**: **ApplicationAdmin** \r\nThe right to add/remove/change code signing\ \ applications and application collections\r\n\r\n**64**: **ApproveUse** \r\nThe right to approve use of a key for\ \ signing\r\n\r\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\r\ \n" format: int32 CodeSigning_SignTemplateValueInfo: title: Metadata information about a code signing template value enum: - 1 - 2 - 3 type: integer description: "\r\n\r\n**1**: **SuggestedList** \r\nThe value represents a list of possible values that may be disregarded\r\ \n\r\n**2**: **LockedList** \r\nThe value represents an exhaustive list of possible choices\r\n\r\n**3**: **ApiLoadedList**\ \ \r\nThe value represents a list of values loaded from an external api\r\n" format: int32 Core_MetadataType: title: Enumeration of possible metadata types enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\r\n\r\n**0**: **Unknown** \r\nUnknown\r\n\r\n**1**: **Text** \r\nText input field\r\n\r\n**2**: **List**\ \ \r\nList selection\r\n\r\n**3**: **Choice** \r\nSingle/Multiple choice\r\n\r\n**4**: **DateTime** \r\nDate/Time\ \ picker\r\n\r\n**5**: **Identity** \r\nIdentity selector\r\n\r\n**6**: **DNReference** \r\nDN\r\n\r\n**7**: **Integer**\ \ \r\nInteger\r\n\r\n**8**: **Boolean** \r\nBoolean\r\n" format: int32 CodeSigning_SignProjectStatus: title: Status enum for the state of a project enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: "\r\n\r\n**0**: **Disabled** \r\nThe project is currently disabled\r\n\r\n**1**: **Enabled** \r\nThe\ \ project is enabled, and ready to be used\r\n\r\n**2**: **Draft** \r\nThe project is being created and cannot be\ \ used\r\n\r\n**3**: **Pending** \r\nThe project has been created but cannot be used. It may be pending approval\r\ \n\r\n**4**: **Deleted** \r\nProject has been marked for deletion\r\n\r\n**5**: **DisabledByParent** \r\nProject\ \ has been marked disabled by parent object\r\n" format: int32 CodeSigning_SignResult: title: The result code of a code signing operation enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 1000 - 1001 - 1002 - 2000 - 2001 - 2002 - 3000 - 3001 - 3002 - 3003 - 3004 - 3005 type: integer description: "\r\n\r\n**0**: **None** \r\nUndefined result\r\n\r\n**1**: **Success** \r\nThe operation was successful\r\ \n\r\n**2**: **InsufficientPermission** \r\nInsufficient permission to perform the operation\r\n\r\n**3**: **CreateFailure**\ \ \r\nFailed to create an object\r\n\r\n**4**: **UpdateFailure** \r\nFailed to update an object\r\n\r\n**5**: **DeleteFailure**\ \ \r\nFailed to delete an object\r\n\r\n**6**: **RenameFailure** \r\nFailed to rename an object\r\n\r\n**7**: **ObjectNotFound**\ \ \r\nRequestion object was not found\r\n\r\n**8**: **IncorrectObjectType** \r\nExpected one object type but was\ \ requesting another\r\n\r\n**9**: **ObjectHasChildren** \r\nOperation prohibited on objects with children\r\n\r\n\ **10**: **AssignPermissionFailure** \r\nFailed to assign permissions\r\n\r\n**11**: **RelatedObjectNotSaved** \r\ \nObject was saved and related objects had changes that were not saved\r\n\r\n**12**: **RemoteError** \r\nAn error\ \ occurred when trying to execute the command via REST API\r\n\r\n**13**: **NotImplemented** \r\nThe requested functionality\ \ has not been implemented yet\r\n\r\n**14**: **UnhandledException** \r\nAn unhandled excpetion was thrown\r\n\r\n\ **15**: **FailedToLoadObject** \r\nFailed to load an object that was required for the operation\r\n\r\n**1000**:\ \ **AssignProjectPermissionFailure** \r\nProject may have been saved, but assigning role permissions failed\r\n\r\ \n**1001**: **DuplicateUserAssignment** \r\nThe user/group was added to a role they were already assigned to\r\n\r\ \n**1002**: **UserNotFound** \r\nThe user/group was not found in the role\r\n\r\n**2000**: **ObjectInGroup** \r\n\ Tried to add an object to the group that was already there.\r\n\r\n**2001**: **ObjectNotInGroup** \r\nTried to remove\ \ an object from the group that was not in the group\r\n\r\n**2002**: **ObjectAlreadyExists** \r\nTried to create\ \ an object and an object with the same name already exists\r\n\r\n**3000**: **EnvironmentMoveRestricted** \r\nTried\ \ to change the project containing an environment\r\n\r\n**3001**: **ValueProhibitedByTemplate** \r\nAn attribute\ \ on the environment does not match what is required by the template\r\n\r\n**3002**: **KeyAccessFailure** \r\nAn\ \ attempt to access the key in this environment has failed\r\n\r\n**3003**: **QueryFailure** \r\nAn error occurred\ \ while performing a search\r\n\r\n**3004**: **ImportFailure** \r\nAn error occurred while performing an import\r\ \n\r\n**3005**: **ObjectsPending** \r\nThe key, certificate, or other object is not yet ready for this environment\r\ \n" format: int32 Core_CredentialResult: title: Error codes for Credential methods enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 112 - 113 - 114 - 115 - 116 - 117 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 209 - 210 - 211 - 300 - 301 - 350 - 351 - 352 - 353 - 354 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 500 - 501 - 502 - 503 - 504 - 505 - 600 - 601 - 602 - 603 - 604 - 700 - 701 - 702 - 703 - 704 - 800 - 801 - 802 - 803 - 804 - 1000 - 1001 - 1002 - 1003 - 1004 - 1005 - 1006 - 1007 - 1008 - 1009 - 1010 - 1011 type: integer description: "\r\n\r\n**1**: **Success** \r\nOperation completed successfully.\r\n\r\n**2**: **InvalidArgument** \r\ \nAn invalid method argument was passed to a method.\r\n\r\n**3**: **InvalidArgumentRange** \r\nAn argument value\ \ is not within the range accepted by a method.\r\n\r\n**4**: **MismatchedArguments** \r\nOne, or more, method argument\ \ counts do not match.\r\n\r\n**5**: **NotImplemented** \r\nThe method has not been implemented.\r\n\r\n**6**: **InvalidDestinationList**\ \ \r\nA method output argument list is invalid.\r\n\r\n**7**: **InsufficientPrivileges** \r\nThe method call has\ \ insufficient permissions to perform an operation.\r\n\r\n**8**: **InvalidOperation** \r\nA method call has been\ \ attempted using an invalid or disposed \r\ninstantiated **Config** object.\r\n\r\n**9**: **UnexpectedAssemblyError**\ \ \r\nAn unexpected error occurred within a called assembly.\r\n\r\n**10**: **InvalidNullArgument** \r\nA null argument\ \ was passed to a method that does not allow null.\r\n\r\n**11**: **FailedToObtainConfig** \r\nCould not get a config\ \ handle.\r\n\r\n**12**: **FailedToObtainSecretStore** \r\nCould not get a secret store handle.\r\n\r\n**13**: **InvalidContainerPath**\ \ \r\nThe provided container path does not start at the credentials root.\r\n\r\n**14**: **RemoteError** \r\nA remote\ \ request failed; see Error property for details\r\n\r\n**100**: **AttributeDoesNotExist** \r\nThe request attribute\ \ does not exist.\r\n\r\n**101**: **AttributeAlreadyExists** \r\nThe attribute name already exists within the attribute\ \ schema, or, as an \r\noptional or mandatory attribute to a class.\r\n\r\n**102**: **AttributeNotFound** \r\nThe\ \ attribute was not within the attribute schema, or, was not found to \r\nhave a value for an object.\r\n\r\n**103**:\ \ **AttributeValueExists** \r\nA matching attribute value already exists for an object.\r\n\r\n**104**: **AttributeStillInUse**\ \ \r\nThe attribute cannot be removed from the attribute schema as the \r\nattribute is still in use by one, or more,\ \ objects.\r\n\r\n**105**: **AttributeNameTooLong** \r\nThe attribute cannot be defined as the attribute name exceeds\ \ the \r\nmaximum defined attribute name length.\r\n\r\n**106**: **AttributeReferenceDoesNotExist** \r\nAn attribute\ \ reference cannot be added to a schema class definition \r\nas the attribute does not exist within the attribute\ \ schema.\r\n\r\n**107**: **AttributeSyntaxCollision** \r\nThe attribute schema definition cannot be created as an\ \ attribute \r\nalready exists within the attribute schema with a different syntax.\r\n\r\n**108**: **AttributePropertyCollision**\ \ \r\nThe attribute schema definition cannot be created as an attribute \r\nalready exists within the attribute schema\ \ with conflicting attribute \r\nproperties.\r\n\r\n**109**: **CannotRemoveMandatory** \r\nThe attribute cannot be\ \ removed from an class schema definition as te \r\nattribute is a mandatory attribute value for the class.\r\n\r\n\ **110**: **AttributeValueIsMandatory** \r\nAn object cannot be created as an class mandatory attribute value has\ \ \r\nnot been set.\r\n\r\n**111**: **AttributeValueTooLong** \r\nAn attribute value cannot be written as the value\ \ of the attribute \r\nexceeds the maximum permitted value length.\r\n\r\n**112**: **IllegalAttributeForClass** \r\ \nAn attribute value cannot be written as the schema class definition \r\ndoes not define the attribute as being mandatory\ \ or optional.\r\n\r\n**113**: **InvalidAttributeDN** \r\nAn attribute value cannot be written as the object distinguished\ \ name, \r\ncontained within the attribute value, does not exist.\r\n\r\n**114**: **AttributeValueDoesNotExist** \ \ \r\nAn attribute value was not found on an object.\r\n\r\n**115**: **AttributeIsSingleValued** \r\nAn attribute\ \ value cannot be written as the attribute already has a \r\nvalue on an object and the attribute is defined as having\ \ only a single \r\nvalue.\r\n\r\n**116**: **AttributeIsReadOnly** \r\nAn attribute value cannot be written since\ \ it is marked as read-only.\r\n\r\n**117**: **AttributeIsHidden** \r\nAn attribute value cannot be written since\ \ it is marked as hidden.\r\n\r\n**200**: **ClassDoesNotExist** \r\nNo schema class definition exists with a matching\ \ name.\r\n\r\n**201**: **ClassAlreadyExists** \r\nA schema class definition already exists with that name.\r\n\r\ \n**202**: **ClassStillInUse** \r\nThe schema class definition cannot be removed from the schema as one, \r\nor more,\ \ objects of the class still exist.\r\n\r\n**203**: **ClassNameTooLong** \r\nThe schema class definition cannot be\ \ created as the name exceeds the \r\nmaximum name permitted for a schema class definition.\r\n\r\n**204**: **ClassInvalidSuperClass**\ \ \r\nThe schema class definition cannot be created due to the fact that one \r\nof the definitions super-classes\ \ do not exist.\r\n\r\n**205**: **ClassInvalidContainmentClass** \r\nThe schema class definition cannot be created\ \ due to the fact that one \r\nof the definitions contained by classes do not exist.\r\n\r\n**206**: **ClassInvalidNamingAttribute**\ \ \r\nThe schema class definition cannot be created due to the fact that one \r\nof the definitions naming attributes\ \ are not defined within the schema \r\nattribute definitions.\r\n\r\n**207**: **ClassInvalidMandatoryAttribute**\ \ \r\nThe schema class definition cannot be created due to the fact that one \r\nof the definitions mandatory attributes\ \ are not defined within the schema \r\nattribute definitions.\r\n\r\n**208**: **ClassInvalidOptionalAttribute** \ \ \r\nThe schema class definition cannot be created due to the fact that one \r\nof the definitions optional attributes\ \ are not defined within the schema \r\nattribute definitions.\r\n\r\n**209**: **ClassInvalidName** \r\nThe schema\ \ class definition cannot be created due to the fact that the \r\nclass name is an empty name.\r\n\r\n**210**: **ClassInvalidContainmentSubClass**\ \ \r\nThe schema class definition cannot be created due to the fact that one \r\nof the definitions contained by\ \ super-classes do not exist.\r\n\r\n**211**: **ClassInvalidStructure** \r\nThe schema class definitions cannot be\ \ loaded due to one, or more, \r\ninvalid class or attribute relations.\r\n\r\n**300**: **PolicyDoesNotExist** \r\ \nNo matching policy was found for the class and attribute combination \r\nfor the object.\r\n\r\n**301**: **PolicyLockStateCollision**\ \ \r\nAn existing policy was found for the class and attribute combination \r\nfor the object; however, the existing\ \ policy lock state does not match \r\nthe lock state of the policy being added.\r\n\r\n**350**: **LockNameAlreadyExists**\ \ \r\nAn existing lock was found for the name given in an new lock attempt.\r\n\r\n**351**: **LockNameDoesNotExist**\ \ \r\nThe specified name is not locked.\r\n\r\n**352**: **LockNameOwnedByAnother** \r\nThe specified name is locked\ \ by another owner.\r\n\r\n**353**: **LockNameLimitReached** \r\nThe specified name, or category, already has reached\ \ the specified \r\nconcurrent locks allowed limit.\r\n\r\n**354**: **LockNameAttemptTimedOut** \r\nThe specified\ \ name is locked by another owner; or, has reached the \r\nspecified concurrent locks allowed limit and could not\ \ be acquired \r\nwithint the specified timeout interval.\r\n\r\n**400**: **ObjectDoesNotExist** \r\nThe specified\ \ object does not exist.\r\n\r\n**401**: **ObjectAlreadyExists** \r\nAn object cannot be created as an object, with\ \ a matching name, already \r\nexists.\r\n\r\n**402**: **ObjectHasChildren** \r\nThe object cannot be deleted as\ \ the object has one, or more, subordinate \r\nchildren objects.\r\n\r\n**403**: **ObjectNameTooLong** \r\nThe object\ \ cannot be created as the object name exceeds the maximum \r\npermitted name length for an object.\r\n\r\n**404**:\ \ **ObjectDepthTooDeep** \r\nThe object cannot be created as the object hiearchical parent count \r\nexceeds the\ \ maximum object depth permitted.\r\n\r\n**405**: **ObjectInvalidName** \r\nThe object cannot be created due to the\ \ fact that the object name is \r\nempty.\r\n\r\n**406**: **ObjectInvalidClass** \r\nThe object cannot be created\ \ due to the fact that no schema class \r\ndefinition was found.\r\n\r\n**407**: **ObjectInvalidContainment** \r\n\ The object cannot be created due to the fact that the parent object's \r\nschema class definition is not defined as\ \ a contained-by class within \r\nthe schema class definition.\r\n\r\n**408**: **ObjectMandatoryMissing** \r\nThe\ \ object cannot be created due to the fact that one, or more, \r\nmandatory attributes, as defined by the object's\ \ schema class definition \r\nwere not provided.\r\n\r\n**409**: **ObjectIsReadOnly** \r\nThe object cannot be modified.\r\ \n\r\n**410**: **ObjectInvalidOperation** \r\nThe operation not allowed on the object.\r\n\r\n**500**: **DriverMissingDSN**\ \ \r\nNo database connection information was found for a storage driver.\r\n\r\n**501**: **DriverMissingDatabaseName**\ \ \r\nThe database connection information does not define the storage driver's \r\ndatabase name.\r\n\r\n**502**:\ \ **DriverDatabaseError** \r\nAn error occurred between the storage driver and it's database.\r\n\r\n**503**: **DriverTransactionError**\ \ \r\nA transaction error occurred during a write operation within a storage \r\ndriver.\r\n\r\n**504**: **DriverTransactionCollision**\ \ \r\nAn existing write operation between the storage driver and a database \r\nis already in progress.\r\n\r\n**505**:\ \ **DriverGenerationUpdateError** \r\nAn attempt to update the storage drivers schema generational qualifier \r\n\ failed.\r\n\r\n**600**: **CacheLockException** \r\nAn operation cannot be completed as a schema cache lock management\ \ error \r\noccurred.\r\n\r\n**601**: **CacheEntryNotFound** \r\nNo matching entry name was found within a schema\ \ cache.\r\n\r\n**602**: **CacheEntryAlreadyExists** \r\nAn entry could not be added to a schema cache as an entry\ \ with a \r\nmatching name already exists.\r\n\r\n**603**: **CacheEntryIsSuperior** \r\nAn entry could not be added\ \ to the schema cache as an entry with \r\na matching name and definitions exist. However, the matching \r\nentry\ \ contains additional definitions.\r\n\r\n**604**: **CacheEntryIsIncompatible** \r\nAn entry could not be added to\ \ a schema cache as an entry with a \r\nmatching name, but with conflicting definitions.\r\n\r\n**700**: **XmlInvalidStructure**\ \ \r\nThe XML document structure is invalid for this purpose.\r\n\r\n**701**: **XmlMissingNaming** \r\nAn XML element\ \ is missing the name attribute.\r\n\r\n**702**: **XmlMissingSyntax** \r\nAn XML element is missing the syntax attribute.\r\ \n\r\n**703**: **XmlMissingProperty** \r\nAn XML element is missing the property attribute.\r\n\r\n**704**: **XmlUnknownElementAttribute**\ \ \r\nAn XML element has an unknown attribute.\r\n\r\n**800**: **AdaptableCredentialNotSupportedType** \r\nThe represented\ \ credential type by the Adaptable Credential is not supported.\r\n\r\n**801**: **AdaptableCredentialScriptHashMismatch**\ \ \r\nThe Adaptable Credential PowerShell script is modified.\r\n\r\n**802**: **AdaptableCredentialScriptError**\ \ \r\nThere is an error returned by the Adaptable Credential PowerShell script.\r\n\r\n**803**: **AdaptableCredentialInvalidConnectorData**\ \ \r\nThe Adaptable Connector data is invalid.\r\n\r\n**804**: **AdaptableCredentialUnexpectedScriptResult** \r\n\ An unexpected Result is returned by the Adaptable Credential PowerShell script.\r\n\r\n**1000**: **SecretStoreFailed**\ \ \r\nThe credential data could not be stored in secret store\r\n\r\n**1001**: **AddAttributeFailed** \r\nAttributes\ \ could not be added to vault object\r\n\r\n**1002**: **UnexpectedException** \r\nEncountered an exception that was\ \ not handled\r\n\r\n**1003**: **PartialDeleteFailure** \r\nEncountered an a problem deleting a object in a recursive\ \ delete; partial delete may already have happened\r\n\r\n**1004**: **CredentialTypeMismatch** \r\nTried to update\ \ a credential with a credential of a different type\r\n\r\n**1005**: **NoDriver** \r\nCould not find a driver for\ \ the credential object\r\n\r\n**1006**: **VaultTypeMismatch** \r\nThe secret stored in the vault doesn't match the\ \ type the credential expects\r\n\r\n**1007**: **DriverDenied** \r\nThe credential driver denied renaming the credential\r\ \n\r\n**1008**: **VaultDataUnrecognized** \r\nThe vault data was not any support format\r\n\r\n**1009**: **KeyStoreFailed**\ \ \r\nThe credential failed to be stored in the KeyStore\r\n\r\n**1010**: **CredentialIsInRecycleBin** \r\nThe credential\ \ failed because it was already in the recycle bin and should be purged prior to reimporting it\r\n\r\n**1011**: **CredentialMissingPrivateData**\ \ \r\nThe credential is missing private data required for its type (e.g., private key for a certificate or password\ \ for Username credential)\r\n" format: int32 Core_Cryptography_Cryptoki_CryptokiObjectType: title: Enumeration of Cryptoki object types enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\r\n\r\n**0**: **Data** \r\n\r\n\r\n**1**: **Certificate** \r\n\r\n\r\n**2**: **PublicKey** \r\n\r\n\ \r\n**3**: **PrivateKey** \r\n\r\n\r\n**4**: **SecretKey** \r\n\r\n\r\n**5**: **HwFeature** \r\n\r\n\r\n**6**:\ \ **DomainParameters** \r\n\r\n\r\n**7**: **Mechanism** \r\n\r\n\r\n**8**: **OtpKey** \r\n\r\n" format: int32 Core_Cryptography_Cryptoki_CryptokiKeyType: title: Enumeration of Cryptoki key types enum: - 0 - 1 - 2 - 3 - 4 - 5 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 64 - 65 - 73 - 74 - 75 - 0 - 82 - 0 - 0 - 0 type: integer description: "\r\n\r\n**0**: **RSA** \r\nRSA Asymmetric Key\r\n\r\n**1**: **DSA** \r\nDSA (Digital Signature Algorithm)\ \ Asymmetric Key\r\n\r\n**2**: **DH** \r\nThe Diffie-Hellman Asymmetric Key\r\n\r\n**3**: **EC** \r\nEC (Elliptic-Curve)\ \ Asymmetric key\r\n\r\n**4**: **X9_42_DH** \r\nX9.42 DH Financial Services Asymmetric Key\r\n\r\n**5**: **KEA**\ \ \r\nKEA (Key Exchange Algorithm) Asymmetric Key\r\n\r\n**16**: **GenericSecret** \r\nGeneric Symmetric Key\r\n\ \r\n**17**: **RC2** \r\nRC2 Symmetric Key\r\n\r\n**18**: **RC4** \r\nRC4 Symmetric Key\r\n\r\n**19**: **DES** \r\ \nDES Symmetric Key\r\n\r\n**20**: **DES2** \r\nDES2 Symmetric Key\r\n\r\n**21**: **DES3** \r\nDES3 Symmetric Key\r\ \n\r\n**22**: **CAST** \r\nCAST Symmetric Key\r\n\r\n**23**: **CAST3** \r\nCAST3 Symmetric Key\r\n\r\n**24**: **CAST128**\ \ \r\nCAST128 Symmetric Key\r\n\r\n**25**: **RC5** \r\nRC5 Symmetric Key\r\n\r\n**26**: **IDEA** \r\nIDEA Symmetric\ \ Key\r\n\r\n**27**: **Skipjack** \r\nSkipjack Symmetric Key\r\n\r\n**28**: **BATON** \r\nBATON Symmetric Key\r\n\ \r\n**29**: **Juniper** \r\nJuniper Symmetric Key\r\n\r\n**30**: **CDMF** \r\nCDMF Symmetric Key\r\n\r\n**31**:\ \ **AES** \r\nAES Symmetric Key\r\n\r\n**32**: **Blowfish** \r\nBlowfish Symmetric Key\r\n\r\n**33**: **Twofish**\ \ \r\nTwofish Symmetric Key\r\n\r\n**34**: **SecurID** \r\nSecurID Symmetric Key\r\n\r\n**35**: **HOTP** \r\nHOTP\ \ Symmetric Key\r\n\r\n**36**: **ACTI** \r\nACTI Symmetric Key\r\n\r\n**37**: **Camellia** \r\nCamellia Symmetric\ \ Key\r\n\r\n**38**: **ARIA** \r\nARIA Symmetric Key\r\n\r\n**64**: **EC_EDWARDS** \r\nEC Edwards Asymmetric Key\r\ \n\r\n**65**: **EC_MONTGOMERY** \r\nEC Montgomery Asymmetric Key\r\n\r\n**73**: **MlKem** \r\nML-KEM\r\n\r\n**74**:\ \ **MlDsa** \r\nML-DSA\r\n\r\n**75**: **SlhDsa** \r\nSLH-DSA\r\n\r\n**2147483648**: **VendorDefined** \r\nFlag\ \ to indicate vendor-defined key\r\n\r\n**82**: **Falcon** \r\nFalcon\r\n\r\n**2147483649**: **PQComposite** \r\n\ A composite PQ / Traditional key\r\n\r\n**2147483650**: **PQHybrid** \r\nA hybrid Traditional + PQ Key\r\n\r\n**4294967295**:\ \ **Unknown** \r\nUnknown (not part of PKCS#11)\r\n" format: int32 Core_PkixNISTStrengthCategory: title: The NIST defined strength of an algorithm enum: - 0 - 65536 - 131072 - 196608 - 262144 - 327680 - 65535 - 2147418112 - 0 type: integer description: "\r\n\r\n**0**: **Uncategorized** \r\nThe algorithm has not yet received a NIST security level categorization\r\ \n\r\n**65536**: **NISTSecurityCategory1** \r\nNIST Security Category 1\r\n\r\n**131072**: **NISTSecurityCategory2**\ \ \r\nNIST Security Category 2\r\n\r\n**196608**: **NISTSecurityCategory3** \r\nNIST Security Category 3\r\n\r\n\ **262144**: **NISTSecurityCategory4** \r\nNIST Security Category 4\r\n\r\n**327680**: **NISTSecurityCategory5** \ \ \r\nNIST Security Category 5\r\n\r\n**65535**: **NISTSecurityStrength** \r\nMask for NIST Security Bit Strength\ \ values\r\n\r\n**2147418112**: **NISTSecurityCategory** \r\nMask for all NIST Security Category values\r\n\r\n**2147483648**:\ \ **Stronger** \r\nInclude algorithms stronger than the specified flag, while searching\r\n\r\n_This field is a flag\ \ and the actual value will be the sum of all applicable enumeration values._\r\n" format: int32 Core_FlowTicketRejectionStatus: title: The rejection severity of a rejected ticket enum: - 0 - 1 - 2 type: integer description: "\r\n\r\n**0**: **None** \r\nTicket has not been rejected\r\n\r\n**1**: **Retry** \r\nProcess has an\ \ issue, fix the issue and retry from the current stage\r\n\r\n**2**: **Final** \r\nProcess cannot complete and must\ \ be restarted from the beginning\r\n" format: int32 Core_FlowTicketResult: title: The result code enumeration for FlowTickets operations enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer description: "\r\n\r\n**0**: **Success** \r\nThe ticket operation was successful\r\n\r\n**1**: **InsufficientPermission**\ \ \r\nInsufficient permission to perform the requested operation\r\n\r\n**2**: **TicketNotFound** \r\nThe requested\ \ ticket was not found in the system\r\n\r\n**3**: **FailedToEnumerateTickets** \r\nAn error occurred while enumerating\ \ tickets\r\n\r\n**4**: **FailedToApproveTickets** \r\nAn error occurred while approving one or more pending tickets\r\ \n\r\n**5**: **FailedToRejectTickets** \r\nAn error occurred while rejecting one or more pending tickets\r\n\r\n\ **6**: **FailedToCreateTicket** \r\nAn error occurred while creating a ticket\r\n\r\n**7**: **FailedToGetTicket**\ \ \r\nAn error occurred while trying to load a ticket\r\n\r\n**8**: **FailedToDeleteTicket** \r\nAn error occurred\ \ while trying to delete a ticket\r\n\r\n**9**: **FailedToUseTicket** \r\nAn error occurred when trying to use an\ \ approved ticket\r\n\r\n**10**: **NoTicketUsesRemain** \r\nAttempted to consume a ticket that has been fully consumed\r\ \n\r\n**11**: **FailedToUpdateTickets** \r\nAn error occurred while trying to update existing approved tickets\r\n" format: int32 Core_Preferences_ResultCode: title: Preference result codes enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\r\n\r\n**0**: **Success** \r\nThe success\r\n\r\n**1**: **DatabaseError** \r\nThe database error\r\n\ \r\n**2**: **MissingDSN** \r\nThe missing DSN\r\n\r\n**3**: **MissingDatabaseName** \r\nThe missing database name\r\ \n\r\n**4**: **AssemblyNotSignedOrTrusted** \r\nThe assembly not signed or trusted\r\n\r\n**5**: **InvalidTppProductName**\ \ \r\nThe invalid TPP product name\r\n\r\n**6**: **UniqueIndexViolationError** \r\nThe unique index violation error\r\ \n\r\n**7**: **NotMasterAdmin** \r\nNot master admin\r\n\r\n**8**: **InvalidId** \r\nInvalid preference ID\r\n" format: int32 Core_RecycleBinResult: title: Enumeration providing result codes for Recycle Bin API operations enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 20000 - 30000 - 40000 type: integer description: "\r\n\r\n**0**: **Success** \r\nThe request completed succesfully\r\n\r\n**1**: **AdminRequired** \r\n\ Only an administrator can make the request\r\n\r\n**2**: **ObjectDoesNotExist** \r\nThe provided object name does\ \ not exist\r\n\r\n**3**: **InvalidGuid** \r\nNo recycled item with that GUID exists\r\n\r\n**4**: **InvalidRecycleBinItem**\ \ \r\nThe recycle bin object has invalid information and cannot be restored\r\n\r\n**5**: **ItemCannotBeRestored**\ \ \r\nRestore is currently not possible\r\n\r\n**6**: **FailedToGetConfigAccess** \r\nCould not obtain a valid _Config_\ \ object\r\n\r\n**7**: **FailedToGetSecretStoreAccess** \r\nCould not obtain a valid _SecretStore_ object\r\n\r\n\ **8**: **ItemCleanupFailed** \r\nFailed to remove the recycle bin item after restoring associated values\r\n\r\n\ **9**: **ActionNotSupported** \r\nThe provided action type is not supported\r\n\r\n**10**: **ActionFailed** \r\n\ The action failed to complete successfully\r\n\r\n**11**: **RemoteIdentityRequired** \r\nA valid identity object\ \ was not supplied\r\n\r\n**12**: **ActionException** \r\nAn exception occurred while running an action\r\n\r\n**13**:\ \ **RemoteTransportFailure** \r\nA request could not be submitted to the remote system due to a transport/network\ \ failure\r\n\r\n**14**: **ToDoRequestFailed** \r\nA request could not be submitted to the ToDo system\r\n\r\n**15**:\ \ **InvalidParameters** \r\nInvalid arguments were passed to a method\r\n\r\n**16**: **UnspecifiedError** \r\nGeneric\ \ failure code\r\n\r\n**20000**: **ConfigResultBase** \r\nBase Value for _ConfigResult_ codes encoded in _RecycleBinResult_\r\ \n\r\n**30000**: **SecretStoreResultBase** \r\nBase Value for _SecretStoreResult_ codes encoded in _RecycleBinResult_\r\ \n\r\n**40000**: **ObjectStoreResultBase** \r\nBase Value for _ObjectStoreResult_ codes encoded in _RecycleBinResult_\r\ \n" format: int32 Core_RecycleBinRestoreState: title: Enumeration providing result codes for Recycle Bin API operations enum: - 0 - 1 - 2 - 3 - 4 type: integer description: "\r\n\r\n**0**: **Unknown** \r\nRestoration state has not been determined\r\n\r\n**1**: **Possible** \ \ \r\nThe item can be restored\r\n\r\n**2**: **SameNameExists** \r\nThe item cannot be restored because an item with\ \ the same original name blocks restoring\r\n\r\n**3**: **ParentDoesNotExist** \r\nThe item could be restored but\ \ the parent container for it no longer exists\r\n\r\n**4**: **OwnerDoesNotExist** \r\nThe vault items cannot be\ \ restored because the object that owned them no longer exists\r\n" format: int32 Core_RecycledItemDetail_DetailType: title: Type of the item detail enum: - 0 - 1 type: integer description: "\r\n\r\n**0**: **Config** \r\nConfig object\r\n\r\n**1**: **Vault** \r\nVault entry\r\n" format: int32 Core_VaultType: title: Enumerations of data types stored in the vault, if the Data should be secret the Secret bit should be set enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 - 1024 - 2048 - 4096 - 8192 - 16384 - 1073758208 - 1073741824 - 1073741826 - 1073741828 - 1073741832 - 1073741840 - 1073741856 - 1073741952 - 1073742080 - 1073742336 - 1073742848 - 1073743872 - 1073745920 - -2147483648 - -2147483392 - -1073741568 - -2147479552 - -1073737728 - -2147483640 - -1073741816 type: integer description: "\r\n\r\n**0**: **None** \r\n\r\n\r\n**1**: **PrivateKey** \r\nIndicates the stored data is a Private\ \ Key\r\n\r\n**2**: **Certificate** \r\nIndicates the stored data is a Certificate\r\n\r\n**4**: **PKCS12** \r\n\ Indicates the stored data is a PKCS12 blob\r\n\r\n**8**: **SymmetricKey** \r\nIndicates the stored data is a Symmetric\ \ Key\r\n\r\n**16**: **State** \r\nIndicates the stored data is an Assembly State Blob\r\n\r\n**32**: **Password**\ \ \r\nIndicates the stored data is a Password\r\n\r\n**64**: **Csr** \r\nIndicates the stored data is a Certificate\ \ Signing Request\r\n\r\n**128**: **Blob** \r\nIndicates the stored data is a Generic Blob\r\n\r\n**256**: **PKCS8**\ \ \r\nIndicates the stored data is a DER formated PKCS8 (Private Key)\r\n\r\n**512**: **PKCS10** \r\nIndicates the\ \ stored data is a DER formatted PKCS10 (CSR)\r\n\r\n**1024**: **File** \r\nIndicates the stored data is a regular\ \ file\r\n\r\n**2048**: **RSAPublicKey** \r\nIndicates the stored data is an RSA public key\r\n\r\n**4096**: **PublicKey**\ \ \r\nIndicates the stored data is a public key\r\n\r\n**8192**: **AccessGrant** \r\nIndicates the stored data is\ \ an access grant\r\n\r\n**16384**: **SshCertificate** \r\nIndicates the stored data is raw OpenSsh certificate material\r\ \n\r\n**1073758208**: **ArchivedSshCertificate** \r\nIndicates the stored data is deleted raw OpenSsh certificate\ \ material\r\n\r\n**1073741824**: **Archived** \r\nOverlay to indicate archived entries\r\n\r\n**1073741826**: **ArchivedCertificate**\ \ \r\nIndicates the stored data is a Certificate\r\n\r\n**1073741828**: **ArchivedPKCS12** \r\nIndicates the stored\ \ data is a PKCS12 blob\r\n\r\n**1073741832**: **ArchivedSymmetricKey** \r\nIndicates the stored data is a Symmetric\ \ Key\r\n\r\n**1073741840**: **ArchivedState** \r\nIndicates the stored data is an Assembly State Blob\r\n\r\n**1073741856**:\ \ **ArchivedPassword** \r\nIndicates the stored data is a Password\r\n\r\n**1073741952**: **ArchivedBlob** \r\n\ Indicates the stored data is a Generic Blob\r\n\r\n**1073742080**: **ArchivedPKCS8** \r\nIndicates the stored data\ \ is a DER formated PKCS8 (Private Key)\r\n\r\n**1073742336**: **ArchivedPKCS10** \r\nIndicates the stored data is\ \ a DER formatted PKCS10 (CSR)\r\n\r\n**1073742848**: **ArchivedFile** \r\nIndicates the stored data is a regular\ \ file\r\n\r\n**1073743872**: **ArchivedRSAPublicKey** \r\nIndicates the archived data is an RSA public key\r\n\r\ \n**1073745920**: **ArchivedPublicKey** \r\nIndicates the stored data is a public key\r\n\r\n**-2147483648**: **Refigram**\ \ \r\nOverlay to indicate Refigram entries.\r\n\r\n**-2147483392**: **RefigramPKCS8** \r\nIndicates the stored data\ \ is a refigram for a private key stored on an HSM\r\n\r\n**-1073741568**: **ArchivedRefigramPKCS8** \r\nIndicates\ \ the stored data is a refigram for a private key stored on an HSM\r\n\r\n**-2147479552**: **RefigramPublicKey** \ \ \r\nIndicates the stored data is a refigram for a public key stored on an HSM\r\n\r\n**-1073737728**: **ArchivedRefigramPublicKey**\ \ \r\nIndicates the stored data is a refigram for a public key stored on an HSM\r\n\r\n**-2147483640**: **RefigramSymmetricKey**\ \ \r\nIndicates the stored data is a refigram for a symmetric key stored on an HSM\r\n\r\n**-1073741816**: **ArchivedRefigramSymmetricKey**\ \ \r\nIndicates the stored data is a refigram for a symmetric key stored on an HSM\r\n" format: int32 Web_SDK_Authentication_OAuthOrderByField: title: Enumeration providing ordering options for OAuth results enum: - 0 - 1 - 2 - 3 - 4 type: integer description: "\r\n\r\n**0**: **Default** \r\nNo order specified\r\n\r\n**1**: **Name** \r\nOrder results by name\r\ \n\r\n**2**: **Vendor** \r\nOrder results by vendor\r\n\r\n**3**: **AccessValidity** \r\nOrder results by access\ \ validity\r\n\r\n**4**: **GrantValidity** \r\nOrder results by grant validity\r\n" format: int32 Web_SDK_Authentication_OAuthRole: title: Roles associated with OAuth APIs enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: "\r\n\r\n**0**: **User** \r\nUser can see only his/her own items (ie, anything related to grants issued\ \ to a specific verified identity)\r\n\r\n**1**: **Auditor** \r\nUser can see everything but change nothing\r\n\r\ \n**2**: **Maintainer** \r\nUser may:\r\n- Modify application settings for specific applications\r\nUse _PermittedApplications_\ \ for to get the list of applications for which the user is a _Maintainer_\r\n\r\n**3**: **Owner** \r\nUser may:\r\ \n- Modify application settings for specific applications\r\n- Modify/delete rules related to specific applications\r\ \n- Delete specific applications\r\n- Can grant/revoke application maintainer for specific applications (delegate\ \ Maintainer to new users)\r\n- Can grant/revoke application admin for specific applications (delegate Owner to new\ \ users)\r\n- Revoke grants issued by application rules\r\nUse _PermittedApplications_ for to get the list of applications\ \ for which the user is an _Owner_\r\n\r\n**4**: **MixedOwnerMaintainer** \r\nUser is _Maintainer_ for some applications,\ \ and _Owner_ for others. To determine\r\npermissions for specific applications, use the OAuthRights.HasXxxRights(application_id)\ \ methods and provide the application ID\r\nUse _PermittedApplications_ for to get the list of applications for which\ \ the user is either an _Owner_ or _Maintainer_\r\n\r\n**5**: **GrantAdmin** \r\nUser may:\r\n- Read all applications\r\ \n- Read all rules\r\n- Read/revoke all grants\r\n\r\n**6**: **Admin** \r\nUser may:\r\n- Create/modify/delete of\ \ all applications\r\n- Create/modify/delete of rules\r\n- Create/delete of grants\r\n- Can grant/revoke application\ \ maintainer and admin role (delegate Owner/Maintainer to new users)\r\n- Can configure global settings (session parameters,\ \ auth parameters, etc)\r\n" format: int32 Web_SDK_Authentication_OAuthResult: title: Enumeration providing result codes for OAuth API enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 type: integer description: "\r\n\r\n**0**: **Success** \r\nThe request completed successfully\r\n\r\n**1**: **Failure** \r\nThe\ \ request could not be completed successfully\r\n\r\n**2**: **ApplicationNotFound** \r\nThe requested application\ \ could not be found\r\n\r\n**3**: **GrantNotFound** \r\nThe requested grant could not be found\r\n\r\n**4**: **RuleNotFound**\ \ \r\nThe requested rule could not be found\r\n\r\n**5**: **DriverError** \r\nA driver error was encountered while\ \ processing the request\r\n\r\n**6**: **InvalidParameters** \r\nInvalid parameters were provided\r\n\r\n**7**: **TokenHashError**\ \ \r\nA token hash error was encountered while processing the request\r\n\r\n**8**: **ExceptionThrown** \r\nAn exception\ \ was thrown while processing the request\r\n\r\n**9**: **InsufficientPrivileges** \r\nThe caller has insufficient\ \ permissions to perform an operation\r\n\r\n**10**: **ObjectInvalid** \r\nThe object is not properly configured\ \ to process the request\r\n\r\n**11**: **AccessTokenExpired** \r\nThe access token used has expired\r\n\r\n**12**:\ \ **AuthenticationMissing** \r\nMissing authentication information\r\n\r\n**13**: **AuthenticationInvalid** \r\n\ Authentication information is not in a valid format\r\n\r\n**14**: **UnsignedCodeForbidden** \r\nOperation forbidden\ \ for unsigned code\r\n\r\n**15**: **RemoteTransportFailure** \r\nA request could not be submitted to the remote\ \ system due to a transport/network failure\r\n\r\n**16**: **RightsAssignmentError** \r\nA rights assignment request\ \ failed\r\n\r\n**17**: **InvalidScope** \r\nA requested scope was invalid\r\n\r\n**18**: **RemoteIdentityRequired**\ \ \r\nA valid identity object was not supplied\r\n\r\n**19**: **ApplicationAlreadyExists** \r\nThe application already\ \ exists\r\n\r\n**20**: **RuleAlreadyExists** \r\nThe rule already exists\r\n\r\n**21**: **JwtMappingNotFound** \ \ \r\nThe JWT mapping could not be found\r\n\r\n**22**: **JwtMappingAlreadyExists** \r\nA JWT mapping with the same\ \ name already exists\r\n\r\n**23**: **ScopeMismatch** \r\nA provided scope doesn't meet given constraints\r\n" format: int32 Core_StatsTier: title: References a statistics tier enum: - 0 - 1 - 2 - 3 - 4 type: integer description: "\r\n\r\n**0**: **Live** \r\nThe live data tier, where data is currently being modified\r\n\r\n**1**:\ \ **Hour** \r\nThe hourly tier. Aggregate data for previous hours is kept\r\n\r\n**2**: **Day** \r\nThe daily tier.\ \ Aggregate data for previous days is kept\r\n\r\n**3**: **Month** \r\nThe monthly tier. Aggregate data for previous\ \ months is kept\r\n\r\n**4**: **Year** \r\nThe yearly tier. Aggregate data for previous years is kept\r\n" format: int32 Permissions_PermissionsResult: title: Permissions operations result enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 type: integer description: "\r\n\r\n**0**: **None** \r\nNo result set\r\n\r\n**1**: **Success** \r\nThe operation completed successfully\r\ \n\r\n**2**: **RemoteError** \r\nA remote request failed; see Error property for details\r\n\r\n**3**: **MissingObjectArgument**\ \ \r\nThe request did not contain an object Guid or DN\r\n\r\n**4**: **MissingPrincipalArgument** \r\nThe request\ \ did not contain a valid principal identity\r\n\r\n**5**: **ObjectDoesNotExist** \r\nThe specific object (DN or\ \ Guid) does not exist\r\n\r\n**6**: **NoAccessControlRights** \r\nThe requestor does not have access control rights\ \ for the specified object\r\n\r\n**7**: **MissingPermissionsArgument** \r\nThe request did not contain Permissions\r\ \n\r\n**8**: **GrantConfigFailed** \r\nFailed to grant Config permissions\r\n\r\n**9**: **GrantSecretStoreFailed**\ \ \r\nFailed to grant SecretStore permissions\r\n\r\n**10**: **GrantUIFailed** \r\nFailed to grant UI permissions\r\ \n\r\n**11**: **GrantFailed** \r\nFailed to grant permissions\r\n\r\n**12**: **RevokeConfigFailed** \r\nFailed to\ \ revoke Config permissions\r\n\r\n**13**: **RevokeSecretStoreFailed** \r\nFailed to revoke SecretStore permissions\r\ \n\r\n**14**: **RevokeUIFailed** \r\nFailed to revoke UI permissions\r\n\r\n**15**: **RevokeFailed** \r\nFailed\ \ to revoke permissions\r\n" format: int32 Core_ConfigResult: title: Error codes for Config methods enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 14 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 112 - 113 - 114 - 115 - 116 - 117 - 118 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 209 - 210 - 211 - 300 - 301 - 350 - 351 - 352 - 353 - 354 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 600 - 601 - 602 - 603 - 604 - 700 - 701 - 702 - 703 - 704 - 800 - 900 type: integer description: "\r\n\r\n**0**: **None** \r\n\r\n\r\n**1**: **Success** \r\nOperation completed successfully.\r\n\r\n\ **2**: **InvalidArgument** \r\nAn invalid method argument was passed to a method.\r\n\r\n**3**: **InvalidArgumentRange**\ \ \r\nAn argument value is not within the range accepted by a method.\r\n\r\n**4**: **MismatchedArguments** \r\n\ One, or more, method argument counts do not match.\r\n\r\n**5**: **NotImplemented** \r\nThe method has not been implemented.\r\ \n\r\n**6**: **InvalidDestinationList** \r\nA method output argument list is invalid.\r\n\r\n**7**: **InsufficientPrivileges**\ \ \r\nThe method call has insufficient permissions to perform an operation.\r\n\r\n**8**: **InvalidOperation** \r\ \nA method call has been attempted using an invalid or disposed \r\ninstantiated **Config** object.\r\n\r\n**9**:\ \ **UnexpectedAssemblyError** \r\nAn unexpected error occurred within a called assembly.\r\n\r\n**10**: **OutOfMemory**\ \ \r\nAn operation failed due to insufficient system resources.\r\n\r\n**11**: **OperationCancelled** \r\nAn operation\ \ was cancelled.\r\n\r\n**14**: **RemoteError** \r\nA remote request failed; see Error property for details\r\n\r\ \n**100**: **AttributeDoesNotExist** \r\nThe request attribute does not exist.\r\n\r\n**101**: **AttributeAlreadyExists**\ \ \r\nThe attribute name already exists within the attribute schema, or, as an \r\noptional or mandatory attribute\ \ to a class.\r\n\r\n**102**: **AttributeNotFound** \r\nThe attribute was not within the attribute schema, or, was\ \ not found to \r\nhave a value for an object.\r\n\r\n**103**: **AttributeValueExists** \r\nA matching attribute\ \ value already exists for an object.\r\n\r\n**104**: **AttributeStillInUse** \r\nThe attribute cannot be removed\ \ from the attribute schema as the \r\nattribute is still in use by one, or more, objects.\r\n\r\n**105**: **AttributeNameTooLong**\ \ \r\nThe attribute cannot be defined as the attribute name exceeds the \r\nmaximum defined attribute name length.\r\ \n\r\n**106**: **AttributeReferenceDoesNotExist** \r\nAn attribute reference cannot be added to a schema class definition\ \ \r\nas the attribute does not exist within the attribute schema.\r\n\r\n**107**: **AttributeSyntaxCollision** \r\ \nThe attribute schema definition cannot be created as an attribute \r\nalready exists within the attribute schema\ \ with a different syntax.\r\n\r\n**108**: **AttributePropertyCollision** \r\nThe attribute schema definition cannot\ \ be created as an attribute \r\nalready exists within the attribute schema with conflicting attribute \r\nproperties.\r\ \n\r\n**109**: **CannotRemoveMandatory** \r\nThe attribute cannot be removed from an class schema definition as te\ \ \r\nattribute is a mandatory attribute value for the class.\r\n\r\n**110**: **AttributeValueIsMandatory** \r\n\ An object cannot be created as an class mandatory attribute value has \r\nnot been set.\r\n\r\n**111**: **AttributeValueTooLong**\ \ \r\nAn attribute value cannot be written as the value of the attribute \r\nexceeds the maximum permitted value\ \ length.\r\n\r\n**112**: **IllegalAttributeForClass** \r\nAn attribute value cannot be written as the schema class\ \ definition \r\ndoes not define the attribute as being mandatory or optional.\r\n\r\n**113**: **InvalidAttributeDN**\ \ \r\nAn attribute value cannot be written as the object distinguished name, \r\ncontained within the attribute value,\ \ does not exist.\r\n\r\n**114**: **AttributeValueDoesNotExist** \r\nAn attribute value was not found on an object.\r\ \n\r\n**115**: **AttributeIsSingleValued** \r\nAn attribute value cannot be written as the attribute already has\ \ a \r\nvalue on an object and the attribute is defined as having only a single \r\nvalue.\r\n\r\n**116**: **AttributeIsReadOnly**\ \ \r\nAn attribute value cannot be written since it is marked as read-only.\r\n\r\n**117**: **AttributeIsHidden**\ \ \r\nAn attribute value cannot be written since it is marked as hidden.\r\n\r\n**118**: **AttributeValueInvalidFormat**\ \ \r\nAn attribute value has an invalid format.\r\n\r\n**200**: **ClassDoesNotExist** \r\nNo schema class definition\ \ exists with a matching name.\r\n\r\n**201**: **ClassAlreadyExists** \r\nA schema class definition already exists\ \ with that name.\r\n\r\n**202**: **ClassStillInUse** \r\nThe schema class definition cannot be removed from the\ \ schema as one, \r\nor more, objects of the class still exist.\r\n\r\n**203**: **ClassNameTooLong** \r\nThe schema\ \ class definition cannot be created as the name exceeds the \r\nmaximum name permitted for a schema class definition.\r\ \n\r\n**204**: **ClassInvalidSuperClass** \r\nThe schema class definition cannot be created due to the fact that\ \ one \r\nof the definitions super-classes do not exist.\r\n\r\n**205**: **ClassInvalidContainmentClass** \r\nThe\ \ schema class definition cannot be created due to the fact that one \r\nof the definitions contained by classes do\ \ not exist.\r\n\r\n**206**: **ClassInvalidNamingAttribute** \r\nThe schema class definition cannot be created due\ \ to the fact that one \r\nof the definitions naming attributes are not defined within the schema \r\nattribute definitions.\r\ \n\r\n**207**: **ClassInvalidMandatoryAttribute** \r\nThe schema class definition cannot be created due to the fact\ \ that one \r\nof the definitions mandatory attributes are not defined within the schema \r\nattribute definitions.\r\ \n\r\n**208**: **ClassInvalidOptionalAttribute** \r\nThe schema class definition cannot be created due to the fact\ \ that one \r\nof the definitions optional attributes are not defined within the schema \r\nattribute definitions.\r\ \n\r\n**209**: **ClassInvalidName** \r\nThe schema class definition cannot be created due to the fact that the \r\ \nclass name is an empty name.\r\n\r\n**210**: **ClassInvalidContainmentSubClass** \r\nThe schema class definition\ \ cannot be created due to the fact that one \r\nof the definitions contained by super-classes do not exist.\r\n\r\ \n**211**: **ClassInvalidStructure** \r\nThe schema class definitions cannot be loaded due to one, or more, \r\n\ invalid class or attribute relations.\r\n\r\n**300**: **PolicyDoesNotExist** \r\nNo matching policy was found for\ \ the class and attribute combination \r\nfor the object.\r\n\r\n**301**: **PolicyLockStateCollision** \r\nAn existing\ \ policy was found for the class and attribute combination \r\nfor the object; however, the existing policy lock state\ \ does not match \r\nthe lock state of the policy being added.\r\n\r\n**350**: **LockNameAlreadyExists** \r\nAn existing\ \ lock was found for the name given in an new lock attempt.\r\n\r\n**351**: **LockNameDoesNotExist** \r\nThe specified\ \ name is not locked.\r\n\r\n**352**: **LockNameOwnedByAnother** \r\nThe specified name is locked by another owner.\r\ \n\r\n**353**: **LockNameLimitReached** \r\nThe specified name, or category, already has reached the specified \r\ \nconcurrent locks allowed limit.\r\n\r\n**354**: **LockNameAttemptTimedOut** \r\nThe specified name is locked by\ \ another owner; or, has reached the \r\nspecified concurrent locks allowed limit and could not be acquired \r\nwithint\ \ the specified timeout interval.\r\n\r\n**400**: **ObjectDoesNotExist** \r\nThe specified object does not exist.\r\ \n\r\n**401**: **ObjectAlreadyExists** \r\nAn object cannot be created as an object, with a matching name, already\ \ \r\nexists.\r\n\r\n**402**: **ObjectHasChildren** \r\nThe object cannot be deleted as the object has one, or more,\ \ subordinate \r\nchildren objects.\r\n\r\n**403**: **ObjectNameTooLong** \r\nThe object cannot be created as the\ \ object name exceeds the maximum \r\npermitted name length for an object.\r\n\r\n**404**: **ObjectDepthTooDeep**\ \ \r\nThe object cannot be created as the object hiearchical parent count \r\nexceeds the maximum object depth permitted.\r\ \n\r\n**405**: **ObjectInvalidName** \r\nThe object cannot be created due to the fact that the object name is \r\n\ empty.\r\n\r\n**406**: **ObjectInvalidClass** \r\nThe object cannot be created due to the fact that no schema class\ \ \r\ndefinition was found.\r\n\r\n**407**: **ObjectInvalidContainment** \r\nThe object cannot be created due to\ \ the fact that the parent object's \r\nschema class definition is not defined as a contained-by class within \r\n\ the schema class definition.\r\n\r\n**408**: **ObjectMandatoryMissing** \r\nThe object cannot be created due to the\ \ fact that one, or more, \r\nmandatory attributes, as defined by the object's schema class definition \r\nwere not\ \ provided.\r\n\r\n**409**: **ObjectIsReadOnly** \r\nThe object cannot be modified.\r\n\r\n**410**: **ObjectInvalidOperation**\ \ \r\nThe operation not allowed on the object.\r\n\r\n**500**: **DriverMissingDSN** \r\nNo database connection information\ \ was found for a storage driver.\r\n\r\n**501**: **DriverMissingDatabaseName** \r\nThe database connection information\ \ does not define the storage driver's \r\ndatabase name.\r\n\r\n**502**: **DriverDatabaseError** \r\nAn error occurred\ \ between the storage driver and its database.\r\n\r\n**503**: **DriverTransactionError** \r\nA transaction error\ \ occurred during a write operation within a storage \r\ndriver.\r\n\r\n**504**: **DriverTransactionCollision** \r\ \nAn existing write operation between the storage driver and a database \r\nis already in progress.\r\n\r\n**505**:\ \ **DriverGenerationUpdateError** \r\nAn attempt to update the storage drivers schema generational qualifier \r\n\ failed.\r\n\r\n**506**: **DriverStatementTimeout** \r\nA SQL statement execution timed out.\r\n\r\n**600**: **CacheLockException**\ \ \r\nAn operation cannot be completed as a schema cache lock management error \r\noccurred.\r\n\r\n**601**: **CacheEntryNotFound**\ \ \r\nNo matching entry name was found within a schema cache.\r\n\r\n**602**: **CacheEntryAlreadyExists** \r\nAn\ \ entry could not be added to a schema cache as an entry with a \r\nmatching name already exists.\r\n\r\n**603**:\ \ **CacheEntryIsSuperior** \r\nAn entry could not be added to the schema cache as an entry with \r\na matching name\ \ and definitions exist. However, the matching \r\nentry contains additional definitions.\r\n\r\n**604**: **CacheEntryIsIncompatible**\ \ \r\nAn entry could not be added to a schema cache as an entry with a \r\nmatching name, but with conflicting definitions.\r\ \n\r\n**700**: **XmlInvalidStructure** \r\nThe XML document structure is invalid for this purpose.\r\n\r\n**701**:\ \ **XmlMissingNaming** \r\nAn XML element is missing the name attribute.\r\n\r\n**702**: **XmlMissingSyntax** \r\ \nAn XML element is missing the syntax attribute.\r\n\r\n**703**: **XmlMissingProperty** \r\nAn XML element is missing\ \ the property attribute.\r\n\r\n**704**: **XmlUnknownElementAttribute** \r\nAn XML element has an unknown attribute.\r\ \n\r\n**800**: **RecycleBinFailed** \r\nA recycle bin operation failed\r\n\r\n**900**: **ConfigCacheEntryIncompatible**\ \ \r\nThe data underlying a config cache entry changed, rendering the existing entry incompatible (e.g. DN changed)\r\ \n" format: int32 Core_SchemaClass_Properties: title: Behavioural properties for schema classes enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 type: integer description: "\r\n\r\n**0**: **None** \r\nA default internal enumeration.\r\n\r\n**1**: **NonRemovable** \r\nObsolete\r\ \n\r\n**2**: **NonEffective** \r\nNo objects, of the schema class, can be created.\r\n\r\n**4**: **Container** \r\ \nObjects, of this schema class, can contain subordinate objects.\r\n\r\n**8**: **SelfContainment** \r\nObjects,\ \ of this schema class, can contain subordinate objects of this schema class.\r\n\r\n**16**: **SuperClass** \r\n\ The associated schema class name is a super-class list entry for this schema class.\r\n\r\n**32**: **ContainedBy**\ \ \r\nThe associated schema class name is a contained by list entry for this schema class.\r\n\r\n**64**: **NamedBy**\ \ \r\nObsolete\r\n\r\n**128**: **Mandatory** \r\nThe associated schema attribute name is a mandatory list entry\ \ for this schema class.\r\n\r\n**256**: **Optional** \r\nThe associated schema attribute name is a optional list\ \ entry for this schema class.\r\n\r\n**512**: **ContainedBySub** \r\nThe associated schema class name is a super-class\ \ whose sub-classes can contain this schema class.\r\n\r\n_This field is a flag and the actual value will be the sum\ \ of all applicable enumeration values._\r\n" format: int32 Core_SchemaAttribute_Syntaxes: title: Data typing for values of a schema attribute enum: - 0 - 2 - 2 - 5 - 5 - 7 - 7 - 11 - 11 - 24 - 24 - 24 - 25 - 26 - 27 - 28 type: integer description: "\r\n\r\n**0**: **None** \r\nA default internal enumeration.\r\n\r\n**2**: **Boolean** \r\nThe attribute\ \ value is a boolean.\r\n\r\n**2**: **Bool** \r\nThe attribute value is a boolean.\r\n\r\n**5**: **CaseIgnoreString**\ \ \r\nThe attribute value is a case insensitive string.\r\n\r\n**5**: **String** \r\nThe attribute value is a case\ \ insensitive string.\r\n\r\n**7**: **DistinguishedName** \r\nThe attribute value is the complete name of an object\ \ within \r\nthe storage system.\r\n\r\n**7**: **DN** \r\nThe attribute value is the complete name of an object within\ \ \r\nthe storage system.\r\n\r\n**11**: **Integer** \r\nThe attribute value is an integer.\r\n\r\n**11**: **Int**\ \ \r\nThe attribute value is an integer.\r\n\r\n**24**: **Date** \r\nThe attribute value is representing a date/time\ \ value.\r\n\r\n**24**: **Time** \r\nThe attribute value is representing a date/time value.\r\n\r\n**24**: **DateTime**\ \ \r\nThe attribute value is representing a date/time value.\r\n\r\n**25**: **Identity** \r\nThe attributes value\ \ is an identity entry value\r\n\r\n**26**: **Secret** \r\nThe attribute value is a vault ID (vault data is encrypted\ \ in secret store)\r\n\r\n**27**: **CertificateSecret** \r\nThe attribute value is a certificate vault ID (vault\ \ data is cleartext in secret store)\r\n\r\n**28**: **File** \r\nThe attribute value is a vault ID (vault data is\ \ cleartext in secret store)\r\n" format: int32 Core_SchemaAttribute_Properties: title: Behavioural properties for schema attributes enum: - 0 - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 type: integer description: "\r\n\r\n**0**: **SingleValued** \r\nDefault\r\n\r\n**0**: **None** \r\nDefault\r\n\r\n**1**: **NonRemovable**\ \ \r\nObsolete\r\n\r\n**2**: **Hidden** \r\nObsolete\r\n\r\n**4**: **PublicRead** \r\nObsolete\r\n\r\n**8**: **ReadOnly**\ \ \r\nObsolete\r\n\r\n**16**: **MultiValued** \r\nValues, of this schema attribute, can have multiple values.\r\n\ \r\n**32**: **AlwaysWritable** \r\nObsolete\r\n\r\n**64**: **Transient** \r\nThis attribute is transient and can\ \ be removed while it is still in use\r\n\r\n**128**: **PolicyEnabled** \r\nValue can be overridden by policy\r\n\ \r\n_This field is a flag and the actual value will be the sum of all applicable enumeration values._\r\n" format: int32 Core_ConfigRights: title: Privileges associated with the CyberArk configuration assembly enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 128 - 256 - 4096 - 65536 - 131072 - 262144 - 524288 - 1048576 - 2097152 - 4194304 - 8388608 - 1073741824 - -2147483648 - 16711681 - 1074069504 - 4542 type: integer description: "\r\n\r\n**0**: **None** \r\nNo privileges.\r\n\r\n**1**: **SchemaRead** \r\nRead schema class and, or,\ \ attribute definitions.\r\n\r\n**2**: **SchemaAdd** \r\nAdd schema class and, or, attribute definitions.\r\n\r\n\ **4**: **SchemaRemove** \r\nRemove schema class and, or, attribute definitions.\r\n\r\n**8**: **SchemaAccessControl**\ \ \r\nGrant and, or, revoke schema privileges.\r\n\r\n**16**: **AttributeRead** \r\nRead value(s) of an attribute.\r\ \n\r\n**32**: **AttributeWrite** \r\nAdd or delete value(s) of an attribute.\r\n\r\n**128**: **AttributeAccessControl**\ \ \r\nGrant and, or, revoke attribute privileges.\r\n\r\n**256**: **AttributeNone** \r\nReserved for future use.\r\ \n\r\n**4096**: **LockManagement** \r\nReserved for future use.\r\n\r\n**65536**: **ObjectView** \r\nRead the defining\ \ details of an object.\r\n\r\n**131072**: **ObjectCreate** \r\nCreate a new object.\r\n\r\n**262144**: **ObjectRead**\ \ \r\nGrant and, or, revoke object privileges.\r\n\r\n**524288**: **ObjectWrite** \r\nGrant and, or, revoke object\ \ privileges.\r\n\r\n**1048576**: **ObjectDelete** \r\nRemove an existing object.\r\n\r\n**2097152**: **ObjectRename**\ \ \r\nChange, or move, an object distinguished name.\r\n\r\n**4194304**: **ObjectAccessControl** \r\nGrant and,\ \ or, revoke object privileges.\r\n\r\n**8388608**: **ObjectPolicyWrite** \r\nWrite policies to objects.\r\n\r\n\ **1073741824**: **Auditor** \r\nRead access for auditing\r\n\r\n**-2147483648**: **ConfigSupervisor** \r\nReserved\ \ for future use.\r\n\r\n**16711681**: **AllPrivileges** \r\nA synonym for all privileges.\r\n\r\n**1074069504**:\ \ **AuditPrivileges** \r\nA synonym for auditing rights\r\n\r\n**4542**: **ObsoleteFields** \r\n\r\n\r\n_This field\ \ is a flag and the actual value will be the sum of all applicable enumeration values._\r\n" format: int32 Core_ConfigPolicy_Properties: title: Behavioural properties for effective attribute values enum: - 0 - 1 type: integer description: "\r\n\r\n**0**: **None** \r\nAn unsed internal enumeration.\r\n\r\n**1**: **Locked** \r\nThe effective\ \ attribute value is locked by the owning object.\r\n\r\n_This field is a flag and the actual value will be the sum\ \ of all applicable enumeration values._\r\n" format: int32 Core_SecretStoreResult: title: Enumeration of SecretStore result codes enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 type: integer description: "\r\n\r\n**0**: **Success** \r\nIndicates the method completed succesfully.\r\n\r\n**1**: **InvalidCallingAssembly**\ \ \r\nIndicates the calling assembly is not signed by Venafi.\r\n\r\n**2**: **CreateDatabaseError** \r\nIndicates\ \ there was an error creating the Database.\r\n\r\n**3**: **UseDatabaseError** \r\nIndicates there was an error attempting\ \ 'use' the Database.\r\n\r\n**4**: **CreateTableError** \r\nIndicates there was an error creating the Database table(s).\r\ \n\r\n**5**: **CreateIndexError** \r\nIndicates there was an error creating the Database table index(s).\r\n\r\n\ **6**: **ConnectionError** \r\nIndicates there was an error connecting to the Database.\r\n\r\n**7**: **TransactionError**\ \ \r\nIndicates there as an error beginning a database transaction.\r\n\r\n**8**: **InvalidVaultID** \r\nIndicates\ \ the specified vaultid is invalid.\r\n\r\n**9**: **InvalidParams** \r\nIndicates one or more invalid parameters\ \ were passed to the function\r\n\r\n**10**: **InsufficientRights** \r\nIndicates the **Rights** passed in were insufficent\ \ to complete the requested action\r\n\r\n**11**: **CryptoFailure** \r\nIndicates the Crypto method(s) failed and\ \ the data cannot be inserted nor retrieved\r\n\r\n**12**: **DeleteSecretFailed** \r\nIndicates the deletion of a\ \ secret failed\r\n\r\n**13**: **AddSecretFailed** \r\nIndicates the adding of a secret failed\r\n\r\n**14**: **RetrieveSecretFailed**\ \ \r\nIndicates the retrieval of a secret failed\r\n\r\n**15**: **RetrieveSecretTypeFailed** \r\nIndicates the retrieval\ \ of the secret type failed\r\n\r\n**16**: **GetNextVaultIDFailed** \r\nIndicates there was an error getting the\ \ next available VaultID\r\n\r\n**17**: **DissacoiateFailed** \r\nIndicates the dissociation of data failed\r\n\r\ \n**18**: **OwnerLookupFailed** \r\nIndicates the OwnerLookup failed\r\n\r\n**19**: **AssociateDataFailed** \r\n\ Indicates the association of data failed\r\n\r\n**20**: **LookupFailed** \r\nIndicates the Lookup failed\r\n\r\n\ **21**: **InvalidKey** \r\nIndicates that an invalid encryption key name was provided\r\n\r\n**22**: **QueryError**\ \ \r\nIndicates an error occurred querying the repository\r\n\r\n**23**: **SecurityGroupNotImplemented** \r\nIndicates\ \ that the associated security group support is not implemented\r\n\r\n**24**: **RemoteError** \r\nA remote request\ \ failed; see Error property for details\r\n\r\n**25**: **VaultIdAlreadyExists** \r\nAn existing store entry already\ \ exists\r\n\r\n**26**: **OutOfMemory** \r\nAn operation could not be performed, at this time, due to resource constraints.\r\ \n\r\n**27**: **AssociationAlreadyExists** \r\nIndicates the association of data failed due to the fact that an existing\ \ matching association already exists.\r\n\r\n**28**: **VaultIdExceedsIntegerCapacity** \r\nThe operation succeeded\ \ but generated a vault ID that exceeds the 32-bit signed integer value.\r\n\r\n**29**: **AssociationLookupFailed**\ \ \r\nThe operation to retrieve data about a vault entry failed\r\n\r\n**30**: **AddRevocationStateFailed** \r\n\ The operation to set the revocation state on a certificate failed\r\n\r\n**31**: **CertificateMigrationStateNotFound**\ \ \r\nThe certificate migration state was not found in the database\r\n\r\n**32**: **TodoManagerError** \r\nAn error\ \ occurred related to a todo manager operation\r\n\r\n**33**: **RotationError** \r\nAn error related to key rotation\ \ occurred\r\n\r\n**34**: **Cancelled** \r\nAn operation was cancelled\r\n\r\n**35**: **DeleteOwnerFailed** \r\n\ Indicates the removal of an owner failed\r\n" format: int32 Core_NestedGroupResolveType: title: Specifies how to resolve nested groups enum: - 0 - 1 - 2 type: integer description: "\r\n\r\n**0**: **DoNotResolve** \r\nDo not resolve nested groups\r\n\r\n**1**: **Resolve** \r\nResolve\ \ nested groups\r\n\r\n**2**: **DriverDefault** \r\nLet the driver determine whether or not to resolve nested groups\r\ \n" format: int32 Core_IdentityResult: title: Result codes for Identity methods enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 1000 - 1001 - 1002 - 1003 - 1004 - 1005 - 2000 - 2001 - 2002 - 3000 - 3001 - 3002 - 3003 - 4000 type: integer description: "\r\n\r\n**1**: **Success** \r\nOperation completed successfully.\r\n\r\n**2**: **InvalidArgument** \r\ \nAn invalid method argument was passed to a method.\r\n\r\n**3**: **InvalidArgumentRange** \r\nAn argument value\ \ is not within the range accepted by a method.\r\n\r\n**4**: **MismatchedArguments** \r\nOne, or more, method argument\ \ counts do not match.\r\n\r\n**5**: **NotImplemented** \r\nThe method has not been implemented.\r\n\r\n**6**: **InvalidNullArgument**\ \ \r\nA null argument was passed to a method that does not allow null.\r\n\r\n**7**: **FailedToAssociateRights**\ \ \r\nCould not associate rights to the identity object.\r\n\r\n**8**: **FailedToVerifyIdentity** \r\nCould not\ \ verify the supplied name and identity.\r\n\r\n**9**: **AssemblyNotSignedOrTrusted** \r\nThe assembly is either\ \ not CyberArk signed or is not a trusted third party assembly.\r\n\r\n**10**: **IdentityPrefixIsNull** \r\nThe identity\ \ prefix is null.\r\n\r\n**11**: **DoesNotSupportManagementMode** \r\nThe driver doesn't support management mode.\r\ \n\r\n**12**: **FailedToCreateEntry** \r\nCould not create entry for new user or group.\r\n\r\n**13**: **OrdinalDoNotMatch**\ \ \r\nOrdinal do no match.\r\n\r\n**14**: **FailedToTranslate** \r\nFailed to translate.\r\n\r\n**15**: **RemoteError**\ \ \r\nA remote request failed; see Error property for details\r\n\r\n**16**: **IdentityDoesNotExist** \r\nThe requested\ \ identity could not be found by any provider\r\n\r\n**1000**: **NoDriver** \r\nCould not find a driver for the identity\ \ object.\r\n\r\n**1001**: **FileLoadException** \r\nCould not load the file.\r\n\r\n**1002**: **FileNotFoundException**\ \ \r\nCould not find the file.\r\n\r\n**1003**: **BadImageFormatException** \r\nBad Image Format\r\n\r\n**1004**:\ \ **InvalidLicense** \r\nInvalid License\r\n\r\n**1005**: **InvalidOperation** \r\nInvalid operation or state.\r\ \n\r\n**2000**: **DatabaseError** \r\nThe database error\r\n\r\n**2001**: **MissingDSN** \r\nThe missing DSN\r\n\ \r\n**2002**: **MissingDatabaseName** \r\nThe missing database name\r\n\r\n**3000**: **AddUniversalFailure** \r\n\ The add universal failure\r\n\r\n**3001**: **DeleteUniversalFailure** \r\nThe delete universal failure\r\n\r\n**3002**:\ \ **UpdateUniversalFullNameFailure** \r\nThe update universal full name failure\r\n\r\n**3003**: **UniversalDoesNotExist**\ \ \r\nThe universal does not exist\r\n\r\n**4000**: **ConfigurationApiNotSupported** \r\nThe provider does not support\ \ the IdentityConfiguration API\r\n" format: int32 Core_MetadataResult: title: Metadata API result codes enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 type: integer description: "\r\n\r\n**0**: **Success** \r\nSuccess\r\n\r\n**1**: **InvalidConfigObject** \r\nAn invalid or **null**_Config_\ \ object was passed\r\n\r\n**2**: **InvalidDN** \r\nA **null** or empty DN string was passed\r\n\r\n**3**: **InvalidName**\ \ \r\nA **null** or empty Name string was passed\r\n\r\n**4**: **InvalidItem** \r\nThe _MetadataObject_ object was\ \ invalid or incomplete\r\n\r\n**5**: **InvalidClass** \r\nThe _SchemaClass_ object was invalid or incomplete\r\n\ \r\n**6**: **InvalidMetadataObject** \r\nThe _MetadataObject_ object was invalid or incomplete\r\n\r\n**7**: **InvalidRights**\ \ \r\nThe rights were invalid to perform the requested operation\r\n\r\n**8**: **ItemIsNull** \r\nA **null**_MetadataObject_\ \ was passed\r\n\r\n**9**: **ItemAlreadyExists** \r\nA _MetadataObject_ object with the same name or label already\ \ exists\r\n\r\n**10**: **ItemTypeUnknown** \r\nThe type of _MetadataObject_ object is not supported\r\n\r\n**11**:\ \ **ConfigCreateFailed** \r\nThe metadata storage failed to create the object\r\n\r\n**12**: **ConfigWriteFailed**\ \ \r\nThe metadata storage failed when updating the object\r\n\r\n**13**: **ConfigDeleteFailed** \r\nThe metadata\ \ storage failed when deleting the object\r\n\r\n**14**: **MetadataInUse** \r\nThe metadata item could not be deleted\ \ because it is still referenced on objects\r\n\r\n**15**: **NoAllowedValues** \r\nThe Metadata item has no allowed\ \ values\r\n\r\n**16**: **AllowedValueDoesNotExist** \r\nThe specified 'allowed' value does not exist\r\n\r\n**17**:\ \ **ValueNotInAllowedList** \r\nThe provided value is not in the list of allowed values\r\n\r\n**18**: **ItemNotValidForClass**\ \ \r\nThe specified metadata item is not valid for the object class\r\n\r\n**19**: **NameTooLong** \r\nThe name\ \ for the metadata item is longer than allowed (255 chars, including its parents)\r\n\r\n**20**: **TooManyContainers**\ \ \r\nThe name for the metadata is nested deeper than allowed\r\n\r\n**21**: **ConfigDnNotContainer** \r\nPassed\ \ DN was expected to be a container\r\n\r\n**22**: **InvalidPolicyState** \r\nCannot write a policy with the specified\ \ policy state\r\n\r\n**23**: **ConfigLockFailed** \r\nFailed to acquire a config lock\r\n\r\n**24**: **ConfigReadFailed**\ \ \r\nFailed to read data from config\r\n\r\n**25**: **RemoteError** \r\nA remote request failed; see Error property\ \ for details\r\n\r\n**26**: **ValueDoesNotMatchRegex** \r\nThe value supplied does not match the regex pattern which\ \ is configured for this metadata type\r\n\r\n**27**: **ArgumentIsNull** \r\nA required argument was null\r\n\r\n\ **28**: **TransientAttributeUnknown** \r\nThe schema attribute matching the metadata item is missing\r\n\r\n**29**:\ \ **BusError** \r\nA bus-related unspecified error\r\n" format: int32 Nullable_1_Core_VaultType_: title: Enumerations of data types stored in the vault, if the Data should be secret the Secret bit should be set enum: - 0 - 1 - 2 - 4 - 8 - 16 - 32 - 64 - 128 - 256 - 512 - 1024 - 2048 - 4096 - 8192 - 16384 - 1073758208 - 1073741824 - 1073741826 - 1073741828 - 1073741832 - 1073741840 - 1073741856 - 1073741952 - 1073742080 - 1073742336 - 1073742848 - 1073743872 - 1073745920 - -2147483648 - -2147483392 - -1073741568 - -2147479552 - -1073737728 - -2147483640 - -1073741816 type: integer description: "\r\n\r\n**0**: **None** \r\n\r\n\r\n**1**: **PrivateKey** \r\nIndicates the stored data is a Private\ \ Key\r\n\r\n**2**: **Certificate** \r\nIndicates the stored data is a Certificate\r\n\r\n**4**: **PKCS12** \r\n\ Indicates the stored data is a PKCS12 blob\r\n\r\n**8**: **SymmetricKey** \r\nIndicates the stored data is a Symmetric\ \ Key\r\n\r\n**16**: **State** \r\nIndicates the stored data is an Assembly State Blob\r\n\r\n**32**: **Password**\ \ \r\nIndicates the stored data is a Password\r\n\r\n**64**: **Csr** \r\nIndicates the stored data is a Certificate\ \ Signing Request\r\n\r\n**128**: **Blob** \r\nIndicates the stored data is a Generic Blob\r\n\r\n**256**: **PKCS8**\ \ \r\nIndicates the stored data is a DER formated PKCS8 (Private Key)\r\n\r\n**512**: **PKCS10** \r\nIndicates the\ \ stored data is a DER formatted PKCS10 (CSR)\r\n\r\n**1024**: **File** \r\nIndicates the stored data is a regular\ \ file\r\n\r\n**2048**: **RSAPublicKey** \r\nIndicates the stored data is an RSA public key\r\n\r\n**4096**: **PublicKey**\ \ \r\nIndicates the stored data is a public key\r\n\r\n**8192**: **AccessGrant** \r\nIndicates the stored data is\ \ an access grant\r\n\r\n**16384**: **SshCertificate** \r\nIndicates the stored data is raw OpenSsh certificate material\r\ \n\r\n**1073758208**: **ArchivedSshCertificate** \r\nIndicates the stored data is deleted raw OpenSsh certificate\ \ material\r\n\r\n**1073741824**: **Archived** \r\nOverlay to indicate archived entries\r\n\r\n**1073741826**: **ArchivedCertificate**\ \ \r\nIndicates the stored data is a Certificate\r\n\r\n**1073741828**: **ArchivedPKCS12** \r\nIndicates the stored\ \ data is a PKCS12 blob\r\n\r\n**1073741832**: **ArchivedSymmetricKey** \r\nIndicates the stored data is a Symmetric\ \ Key\r\n\r\n**1073741840**: **ArchivedState** \r\nIndicates the stored data is an Assembly State Blob\r\n\r\n**1073741856**:\ \ **ArchivedPassword** \r\nIndicates the stored data is a Password\r\n\r\n**1073741952**: **ArchivedBlob** \r\n\ Indicates the stored data is a Generic Blob\r\n\r\n**1073742080**: **ArchivedPKCS8** \r\nIndicates the stored data\ \ is a DER formated PKCS8 (Private Key)\r\n\r\n**1073742336**: **ArchivedPKCS10** \r\nIndicates the stored data is\ \ a DER formatted PKCS10 (CSR)\r\n\r\n**1073742848**: **ArchivedFile** \r\nIndicates the stored data is a regular\ \ file\r\n\r\n**1073743872**: **ArchivedRSAPublicKey** \r\nIndicates the archived data is an RSA public key\r\n\r\ \n**1073745920**: **ArchivedPublicKey** \r\nIndicates the stored data is a public key\r\n\r\n**-2147483648**: **Refigram**\ \ \r\nOverlay to indicate Refigram entries.\r\n\r\n**-2147483392**: **RefigramPKCS8** \r\nIndicates the stored data\ \ is a refigram for a private key stored on an HSM\r\n\r\n**-1073741568**: **ArchivedRefigramPKCS8** \r\nIndicates\ \ the stored data is a refigram for a private key stored on an HSM\r\n\r\n**-2147479552**: **RefigramPublicKey** \ \ \r\nIndicates the stored data is a refigram for a public key stored on an HSM\r\n\r\n**-1073737728**: **ArchivedRefigramPublicKey**\ \ \r\nIndicates the stored data is a refigram for a public key stored on an HSM\r\n\r\n**-2147483640**: **RefigramSymmetricKey**\ \ \r\nIndicates the stored data is a refigram for a symmetric key stored on an HSM\r\n\r\n**-1073741816**: **ArchivedRefigramSymmetricKey**\ \ \r\nIndicates the stored data is a refigram for a symmetric key stored on an HSM\r\n" format: int32 nullable: true Core_WorkflowResult: title: Enumeration for Workflow operation results enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\r\n\r\n**0**: **None** \r\nNone\r\n\r\n**1**: **Success** \r\nSuccess\r\n\r\n**2**: **GenericFailure**\ \ \r\nNondescript failure\r\n\r\n**3**: **TicketDoesNotExist** \r\nThe referenced ticket does not exist\r\n\r\n\ **4**: **InsufficientPrivileges** \r\nNot enough rights\r\n\r\n**5**: **BadArguments** \r\nBad/Invalid arguments\ \ were passed\r\n\r\n**6**: **ObjectDoesNotExist** \r\nThe object DN that the workflow is being attached to does\ \ not exist.\r\n\r\n**7**: **RemoteError** \r\nA remote request failed; see Error property for details\r\n\r\n**8**:\ \ **WorkflowObjectDoesNotExist** \r\nThe object dn for the workflow does not exist.\r\n" format: int32 Core_Severity: title: Severity of the event being logged enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: "\r\n\r\n**1**: **Emergency** \r\nEmergency, the system is unusable.\r\n\r\n**2**: **Alert** \r\nAction\ \ must be taken immediately.\r\n\r\n**3**: **Critical** \r\nCritical conditions are occurring.\r\n\r\n**4**: **Error**\ \ \r\nAn error occurred and was handled; action may need to be taken.\r\n\r\n**5**: **Warning** \r\nAn error occurred\ \ and was handled.\r\n\r\n**6**: **Notice** \r\nNormal but significant condition has occurred.\r\n\r\n**7**: **Info**\ \ \r\nPositive event, for information only\r\n\r\n**8**: **Debug** \r\nDebugging information only\r\n" format: int32 Core_LogFlags: title: Options for logging events enum: - 0 - 1 - 2 - 4 - 8 type: integer description: "\r\n\r\n**0**: **None** \r\nNo flags\r\n\r\n**1**: **Synchronous** \r\nRequest synchronous logging\r\ \n\r\n**2**: **NonBlocking** \r\nRequest immediate return of Log APIs\r\n\r\n**4**: **NonCaching** \r\nDo not cache\ \ the event\r\n\r\n**8**: **SignedChain** \r\nRequire the event to be logged as signed event\r\n\r\n_This field is\ \ a flag and the actual value will be the sum of all applicable enumeration values._\r\n" format: int32 Core_LogResult: title: Result codes for logging enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: "\r\n\r\n**0**: **Success** \r\nSuccess\r\n\r\n**1**: **Failure** \r\nGeneral error\r\n\r\n**2**: **StringTooLong**\ \ \r\nA provided string was too long\r\n\r\n**3**: **DataToLarge** \r\nThe data blob was too long\r\n\r\n**4**:\ \ **ComponentTooLong** \r\nThe component string was too long\r\n\r\n**5**: **BufferTooSmall** \r\nAn internal buffer\ \ was not large enough to process the event\r\n\r\n**6**: **Text1TooLong** \r\nThe Text1 string was too long\r\n\r\ \n**7**: **Text2TooLong** \r\nThe Text2 string was too long\r\n\r\n**8**: **NullArgument** \r\nA field in the event\ \ was null even though it is not allowed to be\r\n\r\n**9**: **LogServerLost** \r\nA field in the event was null\ \ even though it is not allowed to be\r\n\r\n**10**: **BadArguments** \r\nBad arguments were passed to the method\r\ \n" format: int32 Nullable_1_Ssh_WebSDK_DataContract_SshKeyUsageAlert_: title: The class for key usage alert enum: - 1 - 2 type: integer description: "\r\n\r\n**1**: **UntrackedKey** \r\nUntracked key.\r\n\r\n**2**: **UnknownClient** \r\nUnknown client.\r\ \n" format: int32 nullable: true ProductLogic_Ssh_Entities_PolicyViolation: title: Possible policy violations enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 33 - 35 - 36 - 37 - 38 type: integer description: "\r\n\r\n**1**: **IsRootAccessOrphan** \r\nRoot access orphan\r\n\r\n**2**: **IsClientAccessOrphan** \ \ \r\nClient access orphan\r\n\r\n**3**: **IsPrivateKeyOrphan** \r\nPrivate key orphan\r\n\r\n**4**: **IsKnownHostOrphan**\ \ \r\nKnown host orphan\r\n\r\n**5**: **IsRootAccess** \r\nRoot access\r\n\r\n**6**: **IsDuplicateClientPrivateKey**\ \ \r\nDuplicate client private key\r\n\r\n**7**: **IsIllegalAlgorithm** \r\nIllegal algorithm\r\n\r\n**8**: **IsIllegalProtocolVersion**\ \ \r\nIllegal protocol version\r\n\r\n**9**: **IsIllegalVendorFormat** \r\nIllegal vendor format\r\n\r\n**10**:\ \ **IsIllegalForcedCommand** \r\nIllegal forced command\r\n\r\n**11**: **IsIllegalSourceRestrictions** \r\nIllegal\ \ source restriction\r\n\r\n**12**: **IsMissingOptions** \r\nMissing option\r\n\r\n**13**: **IsKeyOlderThanAllowed**\ \ \r\nOlder than allowed\r\n\r\n**16**: **IsSharedPrivateKey** \r\nShared private key\r\n\r\n**17**: **IsUnEncryptedKey**\ \ \r\nUnencrypted key\r\n\r\n**18**: **IsSharedServerAccount** \r\nShared server account\r\n\r\n**19**: **IsPassphraseUnknown**\ \ \r\nPassphrase unknown\r\n\r\n**20**: **IsUnknownClient** \r\nUnknown client\r\n\r\n**21**: **KeyWasNotRotated**\ \ \r\nKey was not rotated\r\n\r\n**22**: **IsEnvironmentCrossing** \r\nEnvironment crossing\r\n\r\n**33**: **IsDuplicateHostPrivateKey**\ \ \r\nDuplicate host private key\r\n\r\n**35**: **IsSymbolicLinkKey** \r\nKey or some of its parent directories\ \ is a symbolic link\r\n\r\n**36**: **IsTooOpenPrivateKeyPermissions** \r\nPrivate key allows other users to read\ \ its material\r\n\r\n**37**: **IsNotApprovedKeyEncryptionAlgorithm** \r\nNot approved PBE algorithm is used for\ \ a key\r\n\r\n**38**: **IsDisallowedKeyFormat** \r\nDisallowed key format\r\n" format: int32 Ssh_WebSDK_DataContract_KeyProcessStatus: title: The possible process status result codes that can occur while Trust Protection Foundation manages public and private keys for devices that use Secure Shell enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer description: "\r\n\r\n**0**: **NoStatus** \r\nIndicates that no status is available for the key.\r\n\r\n**1**: **Provisioning**\ \ \r\nIndicates that key is being provisioned (added or edited) to its device.\r\n\r\n**2**: **Removing** \r\nIndicates\ \ that key is being removed from its device.\r\n\r\n**3**: **FailedToProvision** \r\nIndicates that key failed to\ \ provision (added or edited) to its device.\r\n\r\n**4**: **FailedToRemove** \r\nIndicates that key failed to be\ \ removed from its device.\r\n\r\n**5**: **CleaningUp** \r\nIndicates that the old version of the public key is being\ \ cleaned up.\r\n\r\n**6**: **PendingApproval** \r\nIndicates that a key operation is pending approval.\r\n\r\n**7**:\ \ **PendingMyApproval** \r\nIndicates that a key operation is pending approval from the current user.\r\n" format: int32 Ssh_WebSDK_DataContract_KeysetProcessStatus: title: The possible process status result codes that can occur while Trust Protection Foundation manages public and private keys for devices that use Secure Shell enum: - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer description: "\r\n\r\n**5**: **Rotating** \r\nIndicates that keyset is being rotated.\r\n\r\n**6**: **FailedToRotate**\ \ \r\nIndicates that keyset had error during rotation.\r\n\r\n**7**: **KeyOperationRunning** \r\nIndicates that\ \ at least one add, remove, or options edit operation is occurring with key of the keyset.\r\n\r\n**8**: **RotationSuspended**\ \ \r\nIndicates that keyset rotation is suspended. Waiting for the user to finish manual server reconfiguration,\ \ and then press the Resume button.\r\n\r\n**9**: **RollingBack** \r\nIndicates that keyset rotation is in the process\ \ of moving back to a previous state.\r\n\r\n**10**: **PendingApproval** \r\nIndicates that the keyset has at least\ \ one key operation which is pending approval.\r\n\r\n**11**: **PendingMyApproval** \r\nIndicates that the keyset\ \ has at least one key operation which is pending approval from the current user.\r\n" format: int32 Web_SDK_Authentication_OAuthError: type: object properties: error: type: string description: Gets or sets the short error name error_description: type: string description: Gets or sets the description of the error description: REST OAuth Error Response Drivers_Applications_HashiCorp_REST_CreateRoleRequest_: required: - FolderDn - RoleName type: object properties: FolderDn: type: string description: Dn of the policy object. RoleName: type: string description: HashiCorp role name. Drivers_Applications_HashiCorp_REST_CreateRoleResponse: type: object properties: Guid: type: string description: Guid of created role. Error: type: string description: Error. description: Response for role creation request. Drivers_Applications_HashiCorp_REST_Role: type: object properties: Guid: type: string description: Guid of policy object. FolderDn: type: string description: Dn of the policy object. RoleName: type: string description: HashiCorp role name. WhitelistedDomains: type: array items: type: string description: Whitelisted domains. OrganizationalUnits: type: array items: type: string description: Organizational unit. Organization: type: string description: Organization. City: type: string description: City. State: type: string description: State. Country: type: string description: Country. KeyAlgorithm: type: string description: Key algorithm. KeyBitSize: type: string description: Key strength. PkixParameterSet: type: string description: Pkix Parameter Set EnhancedKeyUsage: type: array items: type: string description: Enhanced key usage (server_flag, client_flag, code_signing_flag, email_protection_flag). Error: type: string description: Error. description: HashiCorp Role policy object. Drivers_Applications_HashiCorp_REST_CreatePkiResponse: type: object properties: Guid: type: string description: Guid of PKI object. CertificateGuid: type: string description: Guid of associated certificate object. Error: type: string description: Error. CertificateDN: type: string description: DN of certificate object. description: Response for PKI create request. Drivers_Applications_HashiCorp_REST_CreatePkiRequest: type: object properties: FolderDn: type: string description: Device DN where PKI object should be created. PkiPath: type: string description: PKI path name. Certificate: type: object properties: CommonName: type: string description: Common name. Organization: type: string description: Organization. OrganizationalUnits: type: array items: type: string description: Organization units. City: type: string description: City. State: type: string description: State. Country: type: string description: Country. SubjectAltNames: type: array items: type: object properties: Name: type: string description: Name TypeName: type: string description: Type (DNS, RFC822, UPN, URI, IP) description: Subject alternative name collection. description: Subject alternative name collection. KeyBitSize: type: string description: DEPRECATED - Use PkixParameterSet KeyAlgorithm: type: string description: DEPRECATED - Use PkixParameterSet PkixParameterSet: type: string description: PKIX Parameter Set description: CA certificate configuration. Installation: type: object properties: Host: type: string description: Pki host. Port: type: integer description: Pki port. format: int32 nullable: true CredentialDn: type: string description: DN of password credential object. description: PKI installation settings. CRLAddress: type: string description: CRL address. OCSPAddress: type: string description: OCSP address. CreateCertificateAuthority: type: boolean description: If true, creates CA if doesn't exist. nullable: true CreatePKIRole: type: boolean description: If true, creates Role if doesn't exist. nullable: true Roles: type: array items: type: string description: Roles. description: Create HashiCorp PKI request. Drivers_Applications_HashiCorp_REST_Pkis: type: object properties: pkis: type: array items: type: object properties: PkiGuid: type: string description: Guid of PKI object. PkiDn: type: string description: DN of PKI object. CertificateGuid: type: string description: Guid of certificate associated to PKI object. CertificateDn: type: string description: DN of certificate associated to PKI object. description: PKI object. description: List if PKI objects. Error: type: string description: Error. description: List of all PKI objects. Drivers_Applications_HashiCorp_REST_PkiResponse: type: object properties: FolderDn: type: string description: Device DN where PKI object should be created. PkiPath: type: string description: PKI path name. Certificate: type: object properties: CommonName: type: string description: Common name. Organization: type: string description: Organization. OrganizationalUnits: type: array items: type: string description: Organization units. City: type: string description: City. State: type: string description: State. Country: type: string description: Country. SubjectAltNames: type: array items: type: object properties: Name: type: string description: Name TypeName: type: string description: Type (DNS, RFC822, UPN, URI, IP) description: Subject alternative name collection. description: Subject alternative name collection. KeyBitSize: type: string description: DEPRECATED - Use PkixParameterSet KeyAlgorithm: type: string description: DEPRECATED - Use PkixParameterSet PkixParameterSet: type: string description: PKIX Parameter Set description: CA certificate configuration. Installation: type: object properties: Host: type: string description: Pki host. Port: type: integer description: Pki port. format: int32 nullable: true CredentialDn: type: string description: DN of password credential object. Status: type: string description: Installation status. InError: type: boolean description: Installation is in error flag. description: PKI installation settings. CRLAddress: type: string description: CRL address. OCSPAddress: type: string description: OCSP address. CreateCertificateAuthority: type: boolean description: If true, creates CA if doesn't exist. CreatePKIRole: type: boolean description: If true, creates Role if doesn't exist. Roles: type: array items: type: string description: Roles. Error: type: string description: Error. description: PKI details. Web_SDK_Authentication_AuthorizeOAuthRequest_device: type: object properties: client_id: type: string description: Client (Application) ID scope: type: string description: Desired Scope Web_SDK_Authentication_AuthorizeOAuthResponse: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token error: type: string description: OAuth Error error_description: type: string description: OAuth Error description expires: type: integer description: The date and time (UTC) when the access token expires format: int64 expires_in: type: integer description: The number of seconds until the token expires format: int64 token_type: type: string description: The application this grant applies to scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for refresh_until: type: integer description: Unixtime when the grant expires and cannot be refreshed anymore format: int64 device_code: type: string description: Device code. Used to poll "token" endpoint. user_code: type: string description: User code. Used to approve or reject the authorization request. verification_uri: type: string description: Verification URI. This URL is supposed to be opened by the user. verification_uri_complete: type: string description: Verification URI that has user code as part of it. interval: type: integer description: The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint. format: int64 description: Holds information about a particular access grant Web_SDK_Authentication_AuthorizeOAuthResponse_device: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for Web_SDK_Authentication_AuthError: type: object properties: error: type: string description: One of the errors defined in RFC 6749 Section 5.2 error_description: type: string description: Detailed error explanation description: Class to generate OAuth Authentication Server error responses (See RFC6749, Section 5.2) Web_SDK_Authentication_AuthorizeOAuthRequest_oauth: type: object properties: client_id: type: string description: Client (Application) ID username: type: string description: Valid username; can be prefixed with provider password: type: string description: Valid password for _Username_ scope: type: string description: Desired Scope Web_SDK_Authentication_AuthorizeOAuthResponse_oauth: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for Web_SDK_Authentication_AuthorizeOAuthRequest_integrated: type: object properties: client_id: type: string description: Client (Application) ID scope: type: string description: Desired Scope Web_SDK_Authentication_AuthorizeOAuthResponse_integrated: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for Web_SDK_Authentication_AuthorizeOAuthRequest_certificate: type: object properties: client_id: type: string description: Client (Application) ID scope: type: string description: Desired Scope Web_SDK_Authentication_AuthorizeOAuthResponse_certificate: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for Web_SDK_Authentication_AuthorizeOAuthRequest_jwt: type: object properties: client_id: type: string description: Client (Application) ID jwt: type: string description: Trusted Json Web Token scope: type: string description: Desired Scope Web_SDK_Authentication_AuthorizeOAuthResponse_jwt: type: object properties: access_token: type: string description: The scope (WebSDK, CSP, etc) this grant applies to refresh_token: type: string description: The token to use to get an updated access token scope: type: string description: The scope of the grant identity: type: string description: The identity the grant is for Web_SDK_Authentication_TokenOAuthRequest: type: object properties: refresh_token: type: string description: Gets or sets the refresh token being used to obtain a new access token. client_id: type: string description: Gets or sets the client id. grant_type: type: string description: OAuth grant type. device_code: type: string description: The device verification code, "device_code" from the device authorization response. description: RFC6749 token request. Web_SDK_Authentication_AuthorizeVerifyResponse: type: object properties: identity: type: string description: The PrefixedUniversal identity the grant has been issued to scope: type: string description: The scope (WebSDK, CSP, etc) this grant applies to valid_for: type: integer description: Number of seconds the access token is valid format: int64 access_issued_on: type: string description: The date and time (UTC) when the access token was issued last access_issued_on_unix_time: type: integer description: Unixtime when the access token was issued last format: int64 access_issued_on_ISO8601: type: string description: The date and time (UTC) when the access token was issued last, in ISO-8601 format expires: type: string description: The date and time (UTC) when the grant expires and cannot be refreshed, null if it does not expire nullable: true expires_unix_time: type: integer description: Unixtime when the grant expires and cannot be refreshed anymore, 0 if it does not expire format: int64 expires_ISO8601: type: string description: The date and time (UTC) when the grant expires and cannot be refreshed, null if it does not expire (in ISO-8601 format) grant_issued_on: type: string description: The date and time (UTC) when the grant was issued grant_issued_on_unix_time: type: integer description: Unixtime when the grant was issued format: int64 grant_issued_on_ISO8601: type: string description: The date and time (UTC) when the grant was issued (in ISO-8601 format) application: type: string description: The application this grant applies to description: Holds information about a particular access grant WebSDK_CertificateRequest_RetrieveByVaultIdRequest_Retrieve__vaultId_: required: - Format - Password - IncludePrivateKey - IncludeChain - RootFirstOrder type: object properties: Format: type: string description: The data format of the retrieved certificate Password: type: string description: 'The password is required if IncludePrivateKey is true and the format is pkcs #12 or JKS. It is used to protect the private key.' IncludePrivateKey: type: boolean description: A flag indicating whether to include the private key. IncludeChain: type: boolean description: A flag indicating whether to include the certificate chain. FriendlyName: type: string description: The friendly name is required if the format is JKS. It is used to set the friendly name of the certificate in the keystore. RootFirstOrder: type: boolean description: A flag indicating whether to order the certificate chain with the root first. KeystorePassword: type: string description: The keystore password is required if the format is JKS. It is used to protect the keystore. EncryptionAlgorithm: type: string description: "Possible encryption algorithm values:\r\n\r\n| OID | Algorithm | Description |\r\n|-----|-----------|-------------|\r\ \n|1.2.840.113549.1.1.1|RSA|A widely-used asymmetric encryption algorithm that provides secure data transmission,\ \ suitable for a variety of security applications including secure communications and data integrity.|\r\n|1.2.840.113549.1.1.7|RSA-OAEP|An\ \ asymmetric encryption algorithm that uses Optimal Asymmetric Encryption Padding (OAEP) to enhance security,\ \ suitable for encryption of sensitive information.|\r\n|1.2.840.113549.1.5.1|PBE-MD2-DES|Outdated and insecure.\ \ Not recommended for use.|\r\n|1.2.840.113549.1.5.3|PBE-MD5-DES|Outdated and insecure. Not recommended for use.|\r\ \n|1.2.840.113549.1.5.4|PBE-MD2-RC2-64|Outdated and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.6|PBE-MD5-RC2-64|Outdated\ \ and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.10|PBE-SHA1-DES|Suitable for moderate security\ \ needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.11|PBE-SHA1-RC2-64|Provides moderate\ \ security. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1|Weak security\ \ due to vulnerabilities. Not recommended for use..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1-3DES|Weak security\ \ due to vulnerabilities. Suitable for moderate security needs but not recommended for high-security applications.|\r\ \n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA256|Suitable for typical security needs. Recommended over SHA-1 but not\ \ ideal for high-security applications..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA384|Strong security, but limited\ \ adoption. Suitable for high-security encryption if supported by recipient.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA512|Strong\ \ security, suitable for high-security encryption.|\r\n|1.2.840.113549.1.12.1.3|PBE-SHA1-3DES|Suitable for securing\ \ sensitive data with moderate security needs. Not recommended for high-security applications due to outdated\ \ components.|\r\n|1.2.840.113549.1.12.1.4|PBE-SHA1-2DES|Suitable for moderate security needs. Not recommended\ \ for high-security applications.|\r\n|1.2.840.113549.1.12.1.5|PBE-SHA1-RC2-128|Provides moderate security. Not\ \ recommended for high-security applications.|\r\n|1.2.840.113549.1.12.1.6|PBE-SHA1-RC2-40|Offers low security.\ \ Not recommended for sensitive data.|\r\n|1.2.840.113549.1.12.5.1.3|JCEKS-SHA1-3DES|Java variant of PBE-SHA1-3DES:\ \ Suitable for moderate security needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.3.7|DES-EDE3-CBC|112-bit\ \ security (effectively ~80-bit), suitable for legacy compatibility but not recommended for new secure applications.|\r\ \n|2.16.840.1.101.3.4.1.2|AES128-CBC|128-bit security, suitable for moderate security data encryption.|\r\n|2.16.840.1.101.3.4.1.6|AES128-GCM|128-bit\ \ security, ideal for secure communications.|\r\n|2.16.840.1.101.3.4.1.22|AES192-CBC|192-bit security, suitable\ \ for higher security data encryption.|\r\n|2.16.840.1.101.3.4.1.26|AES192-GCM|192-bit security, ideal for secure\ \ communications with higher security needs.|\r\n|2.16.840.1.101.3.4.1.42|AES256-CBC|256-bit security, suitable\ \ for highly sensitive data encryption.|\r\n|2.16.840.1.101.3.4.1.46|AES256-GCM|256-bit security, ideal for secure\ \ communications with the highest security needs.|" WebSDK_CertificateRequest_RetrieveResponse: type: object properties: CertificateData: type: string description: The certificate data in the requested format. Format: type: string description: The format of the retrieved certificate. Filename: type: string description: The filename for the retrieved certificate. Status: type: string description: The status of the certificate retrieval process. Stage: type: integer description: The stage of the certificate retrieval process. format: int32 nullable: true Error: type: string description: Error message if the certificate retrieval process failed. description: The class for certificate retrieve response. WebSDK_CertificateRequest_RetrieveResponse_Retrieve__vaultId_: type: object properties: CertificateData: type: string description: The certificate data in the requested format. Format: type: string description: The format of the retrieved certificate. Filename: type: string description: The filename for the retrieved certificate. Status: type: string description: The status of the certificate retrieval process. Stage: type: integer description: The stage of the certificate retrieval process. format: int32 nullable: true Error: type: string description: Error message if the certificate retrieval process failed. IO_Stream: type: object WebSDK_CertificateRequest_PreviousVersionsResponse: type: object properties: Error: type: string description: Contains an error message if the operation failed. Warning: type: string description: Contains a warning message if there are any warnings during the operation. Success: type: boolean description: Indicates whether the operation was successful. PreviousVersions: type: array items: type: object properties: VaultId: type: integer description: The vault ID of the previous certificate version. format: int64 CertificateDetails: type: object properties: Subject: type: string description: The subject of the certificate. E: type: string description: The email address associated with the certificate. CN: type: string description: The common name of the certificate. C: type: string description: The country associated with the certificate. S: type: string description: The state associated with the certificate. L: type: string description: The locality associated with the certificate. O: type: string description: The organization associated with the certificate. OU: type: array items: type: string description: The organizational unit associated with the certificate. Serial: type: string description: The serial number of the certificate. Issuer: type: string description: The issuer of the certificate. KeySize: type: integer description: The key size of the certificate. format: int32 ValidFrom: type: string description: The date and time when the certificate is valid from, in ISO 8601 format. ValidTo: type: string description: The date and time when the certificate is valid to, in ISO 8601 format. EnhancedKeyUsage: type: string description: The enhanced key usage of the certificate. PublicKeyHash: type: string description: The public key hash of the certificate. KeyAlgorithm: type: string description: The key algorithm of the certificate. KeyAlgorithmName: type: string description: The RFC name of the key algorithm for the certificate. KeyAlgorithmOid: type: string description: The OID of the key algorithm for the certificate. KeyUsage: type: string description: The key usage of the certificate. PkixParameterSet: type: string description: The PKIX parameter set of the key algorithm. SignatureAlgorithm: type: string description: The signature algorithm of the certificate. SignatureAlgorithmName: type: string description: The RFC name of the signature algorithm used to sign the certificate. SignatureAlgorithmOID: type: string description: The OID of the signature algorithm used to sign the certificate. SKIKeyIdentifier: type: string description: The subject key identifier of the certificate. StoreAdded: type: string description: The date the certificate was added to the store, in ISO 8601 format. RevocationStatus: type: string description: The revocation status of the certificate. RevocationDate: type: string description: The date and time when the certificate was revoked, in ISO 8601 format. RevocationInitiatedBy: type: string description: The entity that initiated the revocation of the certificate. SubjectAltNameDNS: type: array items: type: string description: The DNS names associated with the certificate. SubjectAltNameEmail: type: array items: type: string description: The email addresses associated with the certificate. SubjectAltNameIPAddress: type: array items: type: string description: The IP addresses associated with the certificate. SubjectAltNameURI: type: array items: type: string description: The URIs associated with the certificate. SubjectAltNameOtherNameUPN: type: array items: type: string description: The UPNs associated with the certificate. AIACAIssuerURL: type: array items: type: string description: The AIA CA Issuer URLs associated with the certificate. AIAKeyIdentifier: type: string description: The AIA Key Identifier associated with the certificate. CDPURI: type: string description: The CDP URI associated with the certificate. TemplateMajorVersion: type: string description: The template major version used to issue the certificate. TemplateMinorVersion: type: string description: The template minor version used to issue the certificate. TemplateOID: type: string description: The template OID used to issue the certificate. TemplateName: type: string description: The template name used to issue the certificate. Thumbprint: type: string description: The thumbprint (SHA1 Hash) of the certificate. EllipticCurve: type: string description: The elliptic curve of the certificate. description: The details of the previous certificate version. description: The class for certificate previous version data. description: The list of previous certificate versions. description: The class for GET certificate previous versions method response. WebSDK_CertificateRequest_ValidateRequest: type: object properties: CertificateDNs: type: array items: type: string description: The list of certificate Distinguished Names (DNs) to validate. CertificateGUIDs: type: array items: type: string description: The list of certificate GUIDs to validate. description: Request to validate certificates. WebSDK_CertificateRequest_ValidateResponse: type: object properties: Error: type: string description: Error message if any validation process failed. Warnings: type: array items: type: string description: A list of warning messages encountered during the validation process. ValidatedCertificateGUIDs: type: array items: type: string description: A list of validated certificate GUIDs. ValidatedCertificateDNs: type: array items: type: string description: A list of validated certificate DNs. Success: type: boolean description: Indicates whether the validation process was successful. description: Certificates validate response. WebSDK_CertificateRequest_PutRequest__guid_: required: - AttributeData type: object properties: AttributeData: type: object description: List of attribute names and values. WebSDK_CertificateRequest_PutResponse: type: object properties: Error: type: string description: Contains an error message if the operation failed. Warning: type: string description: Contains a warning message if there are any warnings during the operation. Success: type: boolean description: Indicates whether the operation was successful. description: The class for put certificate method response. WebSDK_CertificateRequest_CheckPolicyRequest: type: object properties: PolicyDN: type: string description: The Distinguished Name (DN) of the policy to be checked. This must reference a valid policy in the system. PKCS10: type: string description: The PKCS#10 certificate signing request (CSR) to be checked against the policy. description: Check policy request. WebSDK_CertificateRequest_CheckPolicyResponse: type: object properties: Policy: type: object properties: Subject: type: object properties: Organization: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The organization. OrganizationalUnit: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Locked: type: boolean description: The locked flag. description: The organization units. City: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The city. State: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The state. Country: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The country. description: The subject. KeyPair: type: object properties: KeyAlgorithm: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: DEPRECATED - use PkixParameterSet instead KeySize: type: object properties: Value: type: integer description: The value. format: int32 Locked: type: boolean description: The locked flag. description: DEPRECATED - use PkixParameterSet instead EllipticCurve: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: DEPRECATED - use PkixParameterSet instead PkixParameterSet: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Locked: type: boolean description: The locked flag. description: The list of PKIX Parameter Set describing all allowed key algorithms (see 'PKIX Parameter Set' section under 'Certificate Management APIs') DefaultPkixParameterSet: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The default PKIX Parameter Set describing the key algorithm used when not specifically specified in a request (see 'PKIX Parameter Set' section under 'Certificate Management APIs') description: The key pair. ManagementType: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The management type. CertificateAuthority: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The certificate authority. CsrGeneration: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The CSR generation. KeyGeneration: type: object properties: Value: type: string description: The value. Locked: type: boolean description: The locked flag. description: The key generation. SidExtension: type: object properties: IsAllowed: type: boolean description: The allowed flag. IsSidOutsideOfConnectedIdentitiesAllowed: type: boolean description: If true, SID values (identities) outside of connected identities allowed. UseRequesterIdentity: type: boolean description: Use requester identity flag. ObjectSid: type: string description: The SID value. Identity: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Locked: type: boolean description: The locked flag. description: The SID extension value. WhitelistedDomains: type: array items: type: string description: The list of white domains. AllowedSanOtherNameOids: type: array items: type: string description: The list of allowed SAN OtherName Custom OIDs. WildcardsAllowed: type: boolean description: The wildcards allowed flag. UniqueSubjectEnforced: type: boolean description: Unique subject enforced flag. SubjAltNameDnsAllowed: type: boolean description: SAN DNS allowed flag. SubjAltNameIpAllowed: type: boolean description: SAN IP allowed flag. SubjAltNameEmailAllowed: type: boolean description: SAN email allowed flag. SubjAltNameUriAllowed: type: boolean description: SAN URI allowed flag. SubjAltNameUpnAllowed: type: boolean description: SAN UPN allowed flag. SubjAltNameCustomAllowed: type: boolean description: SAN OtherName Custom allowed flag. PrivateKeyReuseAllowed: type: boolean description: Private key reuse allowed flag. description: The policy data that was checked against the Certificate Signing Request (CSR). CSR: type: object properties: Details: type: object properties: CommonName: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The common name. Organization: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The organization. OrganizationalUnit: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: The organization units. City: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The city. State: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The state. Country: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The country. SubjAltNameDns: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: SAN DNS. SubjAltNameIp: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: SAN IP. SubjAltNameEmail: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: SAN email. SubjAltNameUri: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: SAN URI. SubjAltNameUpn: type: object properties: Values: type: array items: type: string description: The values as _List`1_. Compliant: type: boolean description: The compliant flag. description: SAN UPN. SubjAltNameOtherNameCustom: type: object properties: Values: type: array items: type: object properties: Values: type: array items: type: string description: The values. Oid: type: string description: The custom SAN OtherName OID. Compliant: type: boolean description: True if the OID and values are compliant with the policy settings. description: Custom SAN OID definition. description: The SAN OtherName Custom values. Compliant: type: boolean description: True if all custom SAN OtherName values are compliant with the policy settings. description: SAN Custom OtherName. KeyAlgorithm: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: DEPRECATED - use PkixParameterSet instead KeySize: type: object properties: Value: type: integer description: The value. format: int32 Compliant: type: boolean description: The compliant flag. description: DEPRECATED - use PkixParameterSet instead EllipticCurve: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: DEPRECATED - use PkixParameterSet instead PkixParameterSet: type: object properties: Value: type: string description: The value. Compliant: type: boolean description: The compliant flag. description: The PKIX Parameter Set describing the key algorithm (see 'PKIX Parameter Set' section under 'Certificate Management APIs') PrivateKeyReused: type: object properties: Value: type: boolean description: The value. Compliant: type: boolean description: The compliant flag. description: The private key reuse. SidExtension: type: object properties: ObjectSid: type: string description: The value. Identity: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The value. Compliant: type: boolean description: The compliant flag. description: The common name. description: The CSR details as _CSRDetails_. Enrollable: type: boolean description: The enrollable flag. description: "The CSR (Certificate Signing Request) data that was checked for compliance with the policy.\r\nThis\ \ includes detailed information about the CSR such as common name, organization, \r\norganizational units, city,\ \ state, country, and various Subject Alternative Names (SANs)." Error: type: string description: A detailed error message describing why the check policy request failed, if applicable. description: Check policy response. WebSDK_CertificateRequest_RequestRequest: type: object properties: PolicyDN: type: string description: The Distinguished Name (DN) of the policy under which the certificate will be created. CADN: type: string description: The Distinguished Name (DN) of the Certificate Authority (CA) to use for issuing the certificate. ObjectName: type: string description: The name of the certificate object. Subject: type: string description: The subject of the certificate. OrganizationalUnit: type: string description: The organizational unit for the certificate. Organization: type: string description: The organization for the certificate. City: type: string description: The city/locality for the certificate. State: type: string description: The state/province for the certificate. Country: type: string description: The country for the certificate. SubjectAltNames: type: array items: type: object properties: Type: $ref: '#/components/schemas/Nullable_1_Core_Cryptography_SubjectAltNameType_' Name: type: string description: SAN name. Custom SAN _OtherName_ format is either "oid:value" or "friendlyname:value". IsCustom: type: boolean description: "True if the SAN is custom _OtherName_. Unknown (not registered) OIDs are rejected.\r\nThis flag\ \ is ignored if the _TypeName_ is not _OtherName_." TypeName: type: string description: The type name. description: The class for SAN item data. description: The Subject Alternative Names (SANs) for the certificate. Contacts: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The contacts for the certificate. Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The approvers for the certificate. CASpecificAttributes: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The Certificate Authority-specific attributes for the certificate request. PKCS10: type: string description: The PKCS#10 certificate signing request (CSR) data. DisableAutomaticRenewal: type: boolean description: A flag indicating whether automatic renewal should be disabled for the certificate. nullable: true ManagementType: type: string description: The management type for the certificate. SetWorkToDo: type: boolean description: A flag indicating whether to set a work to do item for the certificate request. nullable: true WorkToDoTimeout: type: integer description: Number of seconds to wait for the certificate enrollment or renewal to finish before returning format: int32 nullable: true Devices: type: array items: type: object properties: PolicyDN: type: string description: The policy DN. ObjectName: type: string description: The object name. Description: type: string description: The description. Contacts: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The contacts. Host: type: string description: The host. Port: type: integer description: The port number. format: int32 nullable: true CredentialDN: type: string description: The credential DN. TempDirectory: type: string description: The temp directory. UseSudo: type: boolean description: The use SUDO flag. nullable: true SudoCredentialDN: type: string description: The sudo credential DN. ConcurrentConnectionLimit: type: integer description: The concurrent connections limit. format: int32 nullable: true TrustedFingerprint: type: string description: The trusted fingerprint. EnforceKnownHost: type: boolean description: The enforce known host flag. nullable: true CreatedBy: type: string description: The created by info. Applications: type: array items: type: object properties: Description: type: string description: Description. ObjectName: type: string description: Object name. DriverName: type: string description: Driver name. Class: type: string description: Class name. Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: List of approvers. Contacts: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: List of contacts. CreatedBy: type: string description: Created by. PrivateKeyCredentialDN: type: string description: Private key credential DN. DisableValidation: type: boolean description: Disable validation flag. nullable: true DisableNetworkValidation: type: boolean description: Disable network validation flag. nullable: true ValidationHost: type: string description: Validation host. ValidationPort: type: integer description: Validation port. format: int32 nullable: true ClassSpecificAttributes: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: A list of specific attributes. description: Application data. description: The applications. CloudInstanceID: type: string description: The cloud instance ID. CloudRegion: type: string description: The cloud region. CloudService: type: string description: The cloud service. description: The class for device data. description: The devices associated with the certificate. CreatedBy: type: string description: The user or system that created the certificate request. PkixParameterSet: type: string description: The PKIX Parameter Set describing the desired key (see 'PKIX Parameter Set' section under 'Certificate Management APIs') KeyAlgorithm: type: string description: DEPRECATED - use _PkixParameterSet_ instead KeyBitSize: type: integer description: DEPRECATED - use _PkixParameterSet_ instead format: int32 nullable: true EllipticCurve: type: string description: DEPRECATED - use _PkixParameterSet_ instead ParameterSet: type: string description: DEPRECATED - use _PkixParameterSet_ instead Reenable: type: boolean description: A flag indicating whether to re-enable the certificate. CertificateType: type: string description: The config class of the certificate to create (X509 Server Certificate, X509 Device Certificate, etc... ); if not specified Server cert will be created. CustomFields: type: array items: type: object properties: Name: type: string description: The custom field name. Values: type: array items: type: string description: A list of string values. description: Contains custom field name and values. description: The list of custom fields to set. Origin: type: string description: The certificate origin to set. Format: type: string description: The data format of the certificate to be returned Password: type: string description: The password to set on the certificate private key (if it is requested) IncludePrivateKey: type: boolean description: A flag indicating whether to include the private key in the response. IncludeChain: type: boolean description: A flag indicating whether to include the certificate chain in the response. FriendlyName: type: string description: The friendly name for the certificate. RootFirstOrder: type: boolean description: A flag indicating whether to order the certificate chain with the root first. KeystorePassword: type: string description: The keystore password. SidExtensionIdentity: type: string description: The AD identity to resolve the AD Security Identifier (SID) value from. SidExtensionValue: type: string description: The AD Security Identifier (SID) value. If _SidExtensionIdentity_ is provided, this value takes no effect. EncryptionAlgorithm: type: string description: "Possible encryption algorithm values:\r\n\r\n| OID | Algorithm | Description |\r\n|-----|-----------|-------------|\r\ \n|1.2.840.113549.1.1.1|RSA|A widely-used asymmetric encryption algorithm that provides secure data transmission,\ \ suitable for a variety of security applications including secure communications and data integrity.|\r\n|1.2.840.113549.1.1.7|RSA-OAEP|An\ \ asymmetric encryption algorithm that uses Optimal Asymmetric Encryption Padding (OAEP) to enhance security,\ \ suitable for encryption of sensitive information.|\r\n|1.2.840.113549.1.5.1|PBE-MD2-DES|Outdated and insecure.\ \ Not recommended for use.|\r\n|1.2.840.113549.1.5.3|PBE-MD5-DES|Outdated and insecure. Not recommended for use.|\r\ \n|1.2.840.113549.1.5.4|PBE-MD2-RC2-64|Outdated and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.6|PBE-MD5-RC2-64|Outdated\ \ and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.10|PBE-SHA1-DES|Suitable for moderate security\ \ needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.11|PBE-SHA1-RC2-64|Provides moderate\ \ security. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1|Weak security\ \ due to vulnerabilities. Not recommended for use..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1-3DES|Weak security\ \ due to vulnerabilities. Suitable for moderate security needs but not recommended for high-security applications.|\r\ \n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA256|Suitable for typical security needs. Recommended over SHA-1 but not\ \ ideal for high-security applications..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA384|Strong security, but limited\ \ adoption. Suitable for high-security encryption if supported by recipient.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA512|Strong\ \ security, suitable for high-security encryption.|\r\n|1.2.840.113549.1.12.1.3|PBE-SHA1-3DES|Suitable for securing\ \ sensitive data with moderate security needs. Not recommended for high-security applications due to outdated\ \ components.|\r\n|1.2.840.113549.1.12.1.4|PBE-SHA1-2DES|Suitable for moderate security needs. Not recommended\ \ for high-security applications.|\r\n|1.2.840.113549.1.12.1.5|PBE-SHA1-RC2-128|Provides moderate security. Not\ \ recommended for high-security applications.|\r\n|1.2.840.113549.1.12.1.6|PBE-SHA1-RC2-40|Offers low security.\ \ Not recommended for sensitive data.|\r\n|1.2.840.113549.1.12.5.1.3|JCEKS-SHA1-3DES|Java variant of PBE-SHA1-3DES:\ \ Suitable for moderate security needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.3.7|DES-EDE3-CBC|112-bit\ \ security (effectively ~80-bit), suitable for legacy compatibility but not recommended for new secure applications.|\r\ \n|2.16.840.1.101.3.4.1.2|AES128-CBC|128-bit security, suitable for moderate security data encryption.|\r\n|2.16.840.1.101.3.4.1.6|AES128-GCM|128-bit\ \ security, ideal for secure communications.|\r\n|2.16.840.1.101.3.4.1.22|AES192-CBC|192-bit security, suitable\ \ for higher security data encryption.|\r\n|2.16.840.1.101.3.4.1.26|AES192-GCM|192-bit security, ideal for secure\ \ communications with higher security needs.|\r\n|2.16.840.1.101.3.4.1.42|AES256-CBC|256-bit security, suitable\ \ for highly sensitive data encryption.|\r\n|2.16.840.1.101.3.4.1.46|AES256-GCM|256-bit security, ideal for secure\ \ communications with the highest security needs.|" description: The class for certificate request method response. WebSDK_CertificateRequest_RequestResponse: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the created certificate. Guid: type: string description: The GUID of the created certificate. Devices: type: array items: type: object properties: DN: type: string description: The device DN. Warning: type: string description: The warning message if any. Applications: type: array items: type: object properties: DN: type: string description: The application DN. Warning: type: string description: The warning message of any. description: The application response data. description: The list of applications. description: The class for device response data. description: The devices associated with the certificate. Error: type: string description: The error message if any. Warning: type: string description: The warning message if any. CertificateData: type: string description: The certificate data. Format: type: string description: The data format. Filename: type: string description: The filename of the certificate. Status: type: string description: The certificate status. Stage: type: integer description: The certificate processing stage. format: int32 nullable: true description: The class for certificate request method response. WebSDK_CertificateRequest_RequestResponse_Request: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the created certificate. Guid: type: string description: The GUID of the created certificate. Devices: type: array items: type: object properties: DN: type: string description: The device DN. Warning: type: string description: The warning message if any. Applications: type: array items: type: object properties: DN: type: string description: The application DN. Warning: type: string description: The warning message of any. description: The application response data. description: The list of applications. description: The class for device response data. description: The devices associated with the certificate. Warning: type: string description: The warning message if any. CertificateData: type: string description: The certificate data. Format: type: string description: The data format. Filename: type: string description: The filename of the certificate. Status: type: string description: The certificate status. Stage: type: integer description: The certificate processing stage. format: int32 nullable: true Error: type: string description: The error message if any. WebSDK_CertificateRequest_RetrieveRequest_Retrieve: required: - CertificateDN - Format type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be retrieved. Format: type: string description: The format in which to retrieve the certificate (e.g., Base64, DER). Password: type: string description: The password to use if the certificate includes a private key. (Required if IncludePrivateKey is true) KeystorePassword: type: string description: The password for the Java Keystore (JKS) format. (Required if Format is JKS) FriendlyName: type: string description: The friendly name for the certificate. (Required if Format is JKS) IncludePrivateKey: type: boolean description: Indicates whether to include the private key in the response. IncludeChain: type: boolean description: Indicates whether to include the certificate chain in the response. RootFirstOrder: type: boolean description: Indicates whether to order the certificate chain with the root first. EncryptionAlgorithm: type: string description: "Possible encryption algorithm values:\r\n\r\n| OID | Algorithm | Description |\r\n|-----|-----------|-------------|\r\ \n|1.2.840.113549.1.1.1|RSA|A widely-used asymmetric encryption algorithm that provides secure data transmission,\ \ suitable for a variety of security applications including secure communications and data integrity.|\r\n|1.2.840.113549.1.1.7|RSA-OAEP|An\ \ asymmetric encryption algorithm that uses Optimal Asymmetric Encryption Padding (OAEP) to enhance security,\ \ suitable for encryption of sensitive information.|\r\n|1.2.840.113549.1.5.1|PBE-MD2-DES|Outdated and insecure.\ \ Not recommended for use.|\r\n|1.2.840.113549.1.5.3|PBE-MD5-DES|Outdated and insecure. Not recommended for use.|\r\ \n|1.2.840.113549.1.5.4|PBE-MD2-RC2-64|Outdated and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.6|PBE-MD5-RC2-64|Outdated\ \ and insecure. Not recommended for use.|\r\n|1.2.840.113549.1.5.10|PBE-SHA1-DES|Suitable for moderate security\ \ needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.11|PBE-SHA1-RC2-64|Provides moderate\ \ security. Not recommended for high-security applications.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1|Weak security\ \ due to vulnerabilities. Not recommended for use..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA1-3DES|Weak security\ \ due to vulnerabilities. Suitable for moderate security needs but not recommended for high-security applications.|\r\ \n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA256|Suitable for typical security needs. Recommended over SHA-1 but not\ \ ideal for high-security applications..|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA384|Strong security, but limited\ \ adoption. Suitable for high-security encryption if supported by recipient.|\r\n|1.2.840.113549.1.5.13|PBES2-PKCS5-SHA512|Strong\ \ security, suitable for high-security encryption.|\r\n|1.2.840.113549.1.12.1.3|PBE-SHA1-3DES|Suitable for securing\ \ sensitive data with moderate security needs. Not recommended for high-security applications due to outdated\ \ components.|\r\n|1.2.840.113549.1.12.1.4|PBE-SHA1-2DES|Suitable for moderate security needs. Not recommended\ \ for high-security applications.|\r\n|1.2.840.113549.1.12.1.5|PBE-SHA1-RC2-128|Provides moderate security. Not\ \ recommended for high-security applications.|\r\n|1.2.840.113549.1.12.1.6|PBE-SHA1-RC2-40|Offers low security.\ \ Not recommended for sensitive data.|\r\n|1.2.840.113549.1.12.5.1.3|JCEKS-SHA1-3DES|Java variant of PBE-SHA1-3DES:\ \ Suitable for moderate security needs. Not recommended for high-security applications.|\r\n|1.2.840.113549.3.7|DES-EDE3-CBC|112-bit\ \ security (effectively ~80-bit), suitable for legacy compatibility but not recommended for new secure applications.|\r\ \n|2.16.840.1.101.3.4.1.2|AES128-CBC|128-bit security, suitable for moderate security data encryption.|\r\n|2.16.840.1.101.3.4.1.6|AES128-GCM|128-bit\ \ security, ideal for secure communications.|\r\n|2.16.840.1.101.3.4.1.22|AES192-CBC|192-bit security, suitable\ \ for higher security data encryption.|\r\n|2.16.840.1.101.3.4.1.26|AES192-GCM|192-bit security, ideal for secure\ \ communications with higher security needs.|\r\n|2.16.840.1.101.3.4.1.42|AES256-CBC|256-bit security, suitable\ \ for highly sensitive data encryption.|\r\n|2.16.840.1.101.3.4.1.46|AES256-GCM|256-bit security, ideal for secure\ \ communications with the highest security needs.|" WebSDK_CertificateRequest_RenewRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be renewed. PKCS10: type: string description: The PKCS#10 certificate signing request. Reenable: type: boolean description: Indicates whether to re-enable a previously disabled certificate. WorkToDoTimeout: type: integer description: Number of seconds to wait for the todo to finish before returning format: int32 nullable: true Format: type: string description: The format in which to retrieve the renewed certificate (e.g., Base64, DER) Password: type: string description: The password to use if the certificate includes a private key. IncludePrivateKey: type: boolean description: Indicates whether to include the private key in the response. IncludeChain: type: boolean description: Indicates whether to include the certificate chain in the response. FriendlyName: type: string description: The friendly name for the certificate. RootFirstOrder: type: boolean description: Indicates whether to order the certificate chain with the root first. KeystorePassword: type: string description: The password for the Java Keystore (JKS) format. description: The class for renew method request. WebSDK_CertificateRequest_RenewResponse: type: object properties: Error: type: string description: The error message if any error occurred during the renewal process. Success: type: boolean description: Indicates whether the renewal was successful. CertificateData: type: string description: The certificate data in the requested format. Format: type: string description: 'The format of the renewed certificate. Possible formats include: Base64, Base64 (PKCS #8), DER, PKCS #7, PKCS #12, JKS' Filename: type: string description: The filename for the renewed certificate. Status: type: string description: The status of the certificate renewal process. Stage: type: integer description: 'The stage of the certificate renewal process. Stages include: 800 renewal started, 900 renewal completed.' format: int32 nullable: true description: "The class for renew method\tresponse." WebSDK_CertificateRequest_RenewResponse_Renew: type: object properties: Format: type: string description: 'The format of the renewed certificate. Possible formats include: Base64, Base64 (PKCS #8), DER, PKCS #7, PKCS #12, JKS' Filename: type: string description: The filename for the renewed certificate. Status: type: string description: The status of the certificate renewal process. Stage: type: integer description: 'The stage of the certificate renewal process. Stages include: 800 renewal started, 900 renewal completed.' format: int32 nullable: true Error: type: string description: The error message if any error occurred during the renewal process. WebSDK_CertificateRequest_RevokeRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be revoked. Thumbprint: type: string description: The unique hash (SHA-1) of the certificate to be revoked. Reason: $ref: '#/components/schemas/Nullable_1_Core_Revocation_RevocationReason_' Comments: type: string description: Optional comments providing additional details about the revocation request. Disable: type: boolean description: If true, disables the certificate in addition to revocation. Defaults to false. WorkToDoTimeout: type: integer description: The maximum time (in seconds) to wait for revocation processing before returning a response. format: int32 nullable: true description: The class for certificate revoke method request. WebSDK_CertificateRequest_RevokeResponse: type: object properties: Error: type: string description: Contains an error message if the revocation request failed. Warning: type: string description: A warning message if the revocation request is pending or partially completed. Revoked: type: boolean description: A flag that is true if the certificate has been fully revoked and confirmed. Requested: type: boolean description: A flag that is true if the revocation was requested but not yet confirmed. Success: type: boolean description: A flag that is true if the revocation request was processed successfully. description: The class for certificate revoke method response. WebSDK_CertificateRequest_CertificateResults: type: object properties: TotalCount: type: integer description: The total number of certificates being returned. format: int32 DataRange: type: string description: The data range for the current page, e.g., "20-50". Certificates: type: array items: type: object properties: _links: type: array items: type: object properties: Details: type: string description: A string containing the URL to the certificate details. description: Provides the functionality for creating a link to the details of a certificate. description: A list of _CertificateDetailsLink_ objects containing links to the certificate details. CreatedOn: type: string description: The creation date of the certificate in ISO 8601 format. DN: type: string description: The Distinguished Name (DN) of the certificate. Guid: type: string description: The unique identifier (GUID) of the certificate. Name: type: string description: The name of the certificate. ParentDn: type: string description: The Parent Distinguished Name (DN) of the certificate. SchemaClass: type: string description: The schema class of the certificate. X509: type: object properties: CN: type: string description: Certificate Common Name. SANS: type: object properties: DNS: type: array items: type: string description: DNS names. Email: type: array items: type: string description: Emails. IP: type: array items: type: string description: IPs. UPN: type: array items: type: string description: UPNs. URI: type: array items: type: string description: URIs. description: Certificate Subject alternative names. Serial: type: string description: Certificate serial number. Thumbprint: type: string description: Certificate thumbprint. ValidFrom: type: string description: Certificate start date and time. ValidTo: type: string description: Certificate end date and time. Subject: type: string description: Certificate Subject. KeyAlgorithm: type: string description: DEPRECATED - Use PkixParameterSet or KeyAlgorithmName KeySize: type: integer description: DEPRECATED - Use PkixParameterSet format: int32 nullable: true KeyAlgorithmName: type: string description: Certificate RFC name of the key algorithm. KeyAlgorithmOid: type: string description: Certificate dotted-string notation OID of the key algorithm. PkixParameterSet: type: string description: PKIX Parameter Set for the key algorithm. Issuer: type: string description: Certificate Issuer. description: An _X509Details_ object containing detailed X509 information about the certificate. description: Basic Certificate object containing the base properties for a certificate. description: The list of certificates being returned. _links: type: array items: type: object properties: Previous: type: string description: A string containing the URL to the previous page of results. Next: type: string description: A string containing the URL to the next page of results. description: Paging class, used to build and return the pagination links. description: The pagination links for navigating through the certificate results. ErrorDetails: type: string description: The error details, if an error was encountered querying for the certificates. description: Result class containing list of results as well as paging links and count information. WebSDK_CertificateRequest_DetailedCertificateResult: type: object properties: Error: type: string description: Contains an error message if the certificate details retrieval failed. CreatedOn: type: string description: The date the certificate was created. CreatedBy: type: array items: type: string description: The list of users or entities that created the certificate. DN: type: string description: The Distinguished Name (DN) of the certificate Guid: type: string description: The unique identifier of the certificate. Name: type: string description: The name of the certificate. ParentDn: type: string description: The Parent Distinguished Name (DN) of the certificate. SchemaClass: type: string description: The schema class of the certificate. Description: type: string description: The description of the certificate. Contact: type: array items: type: string description: The list of contacts associated with the certificate. Approver: type: array items: type: string description: The list of approvers for the certificate. ManagementType: type: string description: The management type of the certificate. ManagedBy: type: string description: The entity managing the certificate. CertificateAuthorityDN: type: string description: The Distinguished Name (DN) of the Certificate Authority (CA) that issued the certificate. Consumers: type: array items: type: string description: The list of applications or entities that consume the certificate. Disabled: type: boolean description: Indicates whether the certificate is disabled. RenewalDetails: type: object properties: Subject: type: string description: The subject of the certificate. E: type: string description: The email address associated with the certificate. City: type: string description: The city associated with the certificate. State: type: string description: The state associated with the certificate. Country: type: string description: The country associated with the certificate. KeySize: type: integer description: DEPRECATED - Use PkixParameterSet instead format: int32 PkixParameterSet: type: string description: The PKIX parameter set for the key algorithm. Organization: type: string description: The organization associated with the certificate. OrganizationalUnit: type: array items: type: string description: The organizational unit associated with the certificate. SubjectAltNameDNS: type: array items: type: string description: The DNS names associated with the certificate. SubjectAltNameEmail: type: array items: type: string description: The email addresses associated with the certificate. SubjectAltNameIPAddress: type: array items: type: string description: The IP addresses associated with the certificate. SubjectAltNameURI: type: array items: type: string description: The URIs associated with the certificate. SubjectAltNameOtherNameUPN: type: array items: type: string description: The UPNs associated with the certificate. description: Contains renewal details for the certificate. ValidationDetails: type: object properties: ValidationState: type: string description: The validation state of the certificate. LastValidationStateUpdate: type: string description: The date and time when the certificate was last validated, in ISO 8601 format. ValidationDisabled: type: boolean description: True if validation is disabled; otherwise, false. NetworkValidationDisabled: type: boolean description: True if network validation is disabled; otherwise, false. description: Contains validation details for the certificate. CertificateDetails: type: object properties: Subject: type: string description: The subject of the certificate. E: type: string description: The email address associated with the certificate. CN: type: string description: The common name of the certificate. C: type: string description: The country associated with the certificate. S: type: string description: The state associated with the certificate. L: type: string description: The locality associated with the certificate. O: type: string description: The organization associated with the certificate. OU: type: array items: type: string description: The organizational unit associated with the certificate. Serial: type: string description: The serial number of the certificate. Issuer: type: string description: The issuer of the certificate. KeySize: type: integer description: The key size of the certificate. format: int32 ValidFrom: type: string description: The date and time when the certificate is valid from, in ISO 8601 format. ValidTo: type: string description: The date and time when the certificate is valid to, in ISO 8601 format. EnhancedKeyUsage: type: string description: The enhanced key usage of the certificate. PublicKeyHash: type: string description: The public key hash of the certificate. KeyAlgorithm: type: string description: The key algorithm of the certificate. KeyAlgorithmName: type: string description: The RFC name of the key algorithm for the certificate. KeyAlgorithmOid: type: string description: The OID of the key algorithm for the certificate. KeyUsage: type: string description: The key usage of the certificate. PkixParameterSet: type: string description: The PKIX parameter set of the key algorithm. SignatureAlgorithm: type: string description: The signature algorithm of the certificate. SignatureAlgorithmName: type: string description: The RFC name of the signature algorithm used to sign the certificate. SignatureAlgorithmOID: type: string description: The OID of the signature algorithm used to sign the certificate. SKIKeyIdentifier: type: string description: The subject key identifier of the certificate. StoreAdded: type: string description: The date the certificate was added to the store, in ISO 8601 format. RevocationStatus: type: string description: The revocation status of the certificate. RevocationDate: type: string description: The date and time when the certificate was revoked, in ISO 8601 format. RevocationInitiatedBy: type: string description: The entity that initiated the revocation of the certificate. SubjectAltNameDNS: type: array items: type: string description: The DNS names associated with the certificate. SubjectAltNameEmail: type: array items: type: string description: The email addresses associated with the certificate. SubjectAltNameIPAddress: type: array items: type: string description: The IP addresses associated with the certificate. SubjectAltNameURI: type: array items: type: string description: The URIs associated with the certificate. SubjectAltNameOtherNameUPN: type: array items: type: string description: The UPNs associated with the certificate. AIACAIssuerURL: type: array items: type: string description: The AIA CA Issuer URLs associated with the certificate. AIAKeyIdentifier: type: string description: The AIA Key Identifier associated with the certificate. CDPURI: type: string description: The CDP URI associated with the certificate. TemplateMajorVersion: type: string description: The template major version used to issue the certificate. TemplateMinorVersion: type: string description: The template minor version used to issue the certificate. TemplateOID: type: string description: The template OID used to issue the certificate. TemplateName: type: string description: The template name used to issue the certificate. Thumbprint: type: string description: The thumbprint (SHA1 Hash) of the certificate. EllipticCurve: type: string description: The elliptic curve of the certificate. description: Contains detailed information about the certificate. ProcessingDetails: type: object properties: Stage: type: integer description: The processing stage of the certificate. format: int32 nullable: true Status: type: string description: The processing status of the certificate. TicketDN: type: string description: The Ticket Distinguished Name (DN) of the certificate. InError: type: boolean description: True if the certificate is in error; otherwise, false. nullable: true InProcess: type: boolean description: True if the certificate is in process; otherwise, false. nullable: true description: Contains processing details for the certificate. CustomFields: type: array items: type: object properties: Name: type: string description: Gets or sets the custom field name. Type: type: string description: Gets or sets the custom field type. Value: type: array items: type: string description: Gets or sets a list of the custom field values. description: Contains the custom field data. description: The list of custom fields associated with the certificate. Origin: type: string description: The origin of the certificate. description: Detailed Certificate object containing all information for a certificate. WebSDK_CertificateRequest_AssociateRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be associated with an application. This must reference a valid certificate in the system. PushToNew: type: boolean description: A flag indicating whether the certificate should be pushed to new applications. ApplicationDN: type: array items: type: string description: The Distinguished Name (DN) of the application object(s) that will use the certificate. This must be a valid application object in the system. description: Request to associate certificate and applications. WebSDK_CertificateRequest_AssociateResponse: type: object properties: Error: type: string description: A detailed error message describing why the association request failed. Warning: type: string description: A message providing additional information, such as potential issues encountered during the association process. Success: type: boolean description: A flag indicating whether the certificate was successfully associated with the application(s). description: Certificate associate response. WebSDK_CertificateRequest_DissociateRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be dissociated from the application(s). This must reference a valid certificate in the system. ApplicationDN: type: array items: type: string description: The Distinguished Name (DN) of the application object(s) to be dissociated from the certificate. This must be a valid application object in the system. DeleteOrphans: type: boolean description: A flag indicating whether the dissociated applications and devices should be deleted if they become orphans. description: Request to dissociate certificate and applications. WebSDK_CertificateRequest_DissociateResponse: type: object properties: Error: type: string description: A detailed error message describing why the dissociation request failed. Success: type: boolean description: A flag indicating whether the certificate was successfully dissociated from the application(s). description: Certificate dissociate response. WebSDK_CertificateRequest_PushRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to be pushed to the application(s). This must reference a valid certificate in the system. ApplicationDN: type: array items: type: string description: List of Distinguished Names (DNs) of the application objects to which the certificate will be pushed. This must be a valid application object in the system. PushToAll: type: boolean description: A flag indicating whether the certificate should be pushed to all consumers. If this flag is set, do not pass application DNs. description: Request for certificate provisioning to some or all consumers which are valid application DNs for this certificate. WebSDK_CertificateRequest_PushResponse: type: object properties: Error: type: string description: A detailed error message describing why the push request failed. Warning: type: string description: A message providing additional information, such as potential issues encountered during the push process. Success: type: boolean description: A flag indicating whether the certificate was successfully pushed to the application(s). description: Certificate push response. WebSDK_CertificateRequest_DeleteResponse: type: object properties: Error: type: string description: Contains an error message if the delete operation failed. Warning: type: string description: Contains a warning message if there are any warnings during the delete operation. Success: type: boolean description: Indicates whether the delete operation was successful. description: The delete method response. WebSDK_CertificateRequest_ImportRequest: type: object properties: PolicyDN: type: string description: The policy Distinguished Name (DN) where the certificate will be imported. ObjectName: type: string description: The name of the certificate object to be created. CertificateData: type: string description: The certificate data to be imported. PrivateKeyData: type: string description: The private key data associated with the certificate. Password: type: string description: The password for the private key, if applicable. CASpecificAttributes: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The list of Certificate Authority (CA) specific attributes. Reconcile: type: boolean description: A flag indicating whether to reconcile the certificate with existing certificates. description: The import method request. WebSDK_CertificateRequest_ImportResponse: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the imported certificate. Guid: type: string description: The unique identifier of the imported certificate. CertificateVaultId: type: integer description: The vault ID of the imported certificate. format: int64 PrivateKeyVaultId: type: integer description: The vault ID of the imported private key. format: int64 Error: type: string description: Contains an error message if the import operation failed. Warning: type: string description: Contains a warning message if there are any warnings during the import operation. description: The class for import method response. WebSDK_CertificateRequest_ResetRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to reset. Restart: type: boolean description: A flag indicating whether to restart the processing after reset. ClearCSR: type: boolean description: When **true** will clear any CSR present as part of the reset. Default is **false**. nullable: true WorkToDoTimeout: type: integer description: Number of seconds to wait for the todo to finish before returning format: int32 nullable: true description: The class for certificate reset method request. WebSDK_CertificateRequest_ResetResponse: type: object properties: Error: type: string description: Contains an error message if the operation failed. ProcessingResetCompleted: type: boolean description: Indicates whether the processing reset was completed. PrivateKeyMismatchResetCompleted: type: boolean description: Indicates whether the private key mismatch reset was completed. RevocationResetCompleted: type: boolean description: Indicates whether the revocation reset was completed. RestartCompleted: type: boolean description: Indicates whether the restart was completed. description: The class for certificate reset response. WebSDK_CertificateRequest_RetryRequest: type: object properties: CertificateDN: type: string description: The Distinguished Name (DN) of the certificate to retry. WorkToDoTimeout: type: integer description: Number of seconds to wait for the todo to finish before returning format: int32 nullable: true description: The class for certificate retry method request. WebSDK_CertificateRequest_RetryResponse: type: object properties: Error: type: string description: Contains an error message if the retry failed. Success: type: boolean description: Indicates whether the retry was successful. description: The class for certificate retry method response. WebSDK_CertificateRequest_ValidationResultsResponse: type: object properties: SslTls: type: array items: type: object properties: Host: type: string description: The host associated with the validation result IpAddress: type: string description: The IP associated with the validation result Port: type: integer description: The port associated with the validation result format: int32 Sources: type: array items: type: string description: The source(s) of the host associated with the validation result Result: type: object properties: ID: type: integer description: unique identifier for the result format: int32 EndEntity: type: object properties: BitMask: type: integer description: The flags enum format: int32 Values: type: array items: type: string description: The readable strings for bits set in the enum (excluding the 0 enum value) description: The result of the validation for the end-entity certificate Chain: type: object properties: BitMask: type: integer description: The flags enum format: int32 Values: type: array items: type: string description: The readable strings for bits set in the enum (excluding the 0 enum value) description: The result of the validation for the certificate chain Protocols: type: object properties: BitMask: type: integer description: The flags enum format: int32 Values: type: array items: type: string description: The readable strings for bits set in the enum (excluding the 0 enum value) description: The ssl/tls protocols supported by the validation endpoint description: The various ssl/tls and chain results of the validation run description: The class for an SSL/TLS validation result description: Collection of ssl/tls validation results File: type: array items: type: object properties: PerformedOn: type: string description: Last validation date and time. Installation: type: string description: DN of the application. Result: type: array items: type: string description: List of results. description: Class for file validation data. description: Collection of file validation results. description: The class for certificate validation results retrieve method response WebSDK_CertificateRequest_DiscoveryImportRequest: type: object properties: endpoints: type: array items: type: object properties: ip: type: string description: The device IP. host: type: string description: The device hostname. port: type: integer description: The device port. format: int32 nullable: true certificates: type: array items: type: object properties: certificate: type: string description: The certificate data. fingerprint: type: string description: The certificate fingerprint. description: Discovered certificates data. description: The list of discovered certificates. description: Discovered endpoint. description: A list of network endpoints where certificates should be discovered and imported. zoneName: type: string description: The Distinguished Name (DN) of the policy where discovered certificates should be stored. description: Request to import discovery results. WebSDK_CertificateRequest_DiscoveryImportResponse: type: object properties: zoneName: type: string description: The Distinguished Name (DN) of the policy where the certificates were imported. createdCertificates: type: integer description: A list of certificates that were newly created in the system. format: int32 createdInstances: type: integer description: A count of newly created application instances, representing discovered applications that were added to the policy structure. format: int32 updatedCertificates: type: integer description: A list of existing certificates that were already present in the policy and updated with new discovery data. format: int32 updatedInstances: type: integer description: A count of application instances that were found and updated with new configuration details. format: int32 Error: type: string description: A detailed error message if the import process failed. If an error occurs, no certificates or applications will be imported or updated. warnings: type: array items: type: string description: A list of non-critical warnings, such as applications that failed to be created, skipped endpoints due to missing certificate data, or naming conflicts resolved automatically. description: Discovery import response. WebSDK_CertificateRequest_DiscoveryDeleteResponse: type: object properties: Error: type: string description: A detailed error message explaining why the deletion failed (if applicable). Success: type: boolean description: A flag indicating whether the discovery job was successfully deleted. description: The Network Discovery delete method response. WebSDK_Product_CodeSigning_CodeSigningRequest_FindEnvironment: type: object properties: PublicKeyHash: type: string description: The public hash of the key associated to the environment. WebSDK_Product_CodeSigning_CodeSigningResponse_FindEnvironment: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Project: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: A SignProject object that describes the environments rules, restrictions, users and approvers. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CreateEnvironment: required: - EnvironmentName - Project - Template type: object properties: EnvironmentName: type: string description: Specify *DN* or *EnvironmentName*. The name of the new environment you want to create. Project: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: Project DN and GUID are the only required fields from a project. CertificateEnvironment: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. AppleEnvironment: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int64 AppleTemplate: type: object properties: TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizationalunit attribute. CNPattern: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template value for the regex pattern to be used to identify acceptable certificates based on the CN CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _AppleSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. KeyPairEnvironment: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. DotNetEnvironment: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. CSPEnvironment: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. GPGEnvironment: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Settings to create a new certificate environment with. WebSDK_Product_CodeSigning_CodeSigningResponse_CreateEnvironment: type: object properties: Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: Returns true or false if the operation was successful. WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteEnvironment: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the Code Signing Environment to delete. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\[YourProject]\\[YourEnvironment]*.' Guid: type: string description: The globally unique identifier of the Code Signing Environment object. Id: type: integer description: The signing project identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteEnvironment: type: object properties: Error: type: string description: Error message is there was a problem during deletion Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: Success will be either true or false WebSDK_Product_CodeSigning_CodeSigningRequest_GetEnvironment: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\PrjName\\[YourEnvName].*' Guid: type: string description: The GUID that identifies the environment. Id: type: integer description: The environment identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetEnvironment: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RenewEnvironment: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\PrjName\\[YourEnvName].*' Guid: type: string description: The GUID that identifies the environment. Id: type: integer description: The environment identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_RenewEnvironment: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateEnvironment: required: - CertificateEnvironment - AppleEnvironment - KeyPairEnvironment - DotNetEnvironment - CSPEnvironment - GPGEnvironment type: object properties: CertificateEnvironment: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. AppleEnvironment: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int64 AppleTemplate: type: object properties: TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizationalunit attribute. CNPattern: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template value for the regex pattern to be used to identify acceptable certificates based on the CN CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _AppleSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. KeyPairEnvironment: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. DotNetEnvironment: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. CSPEnvironment: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. GPGEnvironment: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Environment settings with their new values. WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateEnvironment: type: object properties: Error: type: string description: Error message if there was a problem while updated. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateProjects: type: object properties: Filter: type: string description: A simple filter on the Project name. Rights: $ref: '#/components/schemas/CodeSigning_SignRight' WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateProjects: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Projects: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: APIs for interacting with _SignProject_ description: An array of SignProject objects that describe environment's rules, restrictions, users, and approvers. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of *false* indicates the request failed due to an *Error*. Otherwise, *true*.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetProject: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing project. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\[YourPrjName].*' Guid: type: string description: The GUID that uniquely identifies the signing project. Id: type: integer description: The signing project identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetProject: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Project: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: A SignProject object that describes the environments rules, restrictions, users and approvers. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CreateProject: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name(DN) of the signing application. Use this syntax in this viewer: ''\\VED\\Code Signing\\Projects\\[project name]'', or in Postman: ''\VED\Code Signing\Projects\[project name]''' WebSDK_Product_CodeSigning_CodeSigningResponse_CreateProject: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Project: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: A code signing project Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProject: required: - Project type: object properties: Project: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this project Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project CreatedOn: type: string description: Gets the creation date of this project Description: type: string description: Gets or sets the description of this code signing project ApprovalSubmissionDate: type: string description: The date this project last went into Pending state ApplicationDNs: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: A collection of Code Signing Application DNs approved for use with this project Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: A list of applications approved for this project Collections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: A list of application collections approved for this project CertificateEnvironments: type: array items: type: object properties: GroupingId: type: integer description: '' format: int64 CertificateStage: type: integer description: Does not work in one to many mode format: int32 CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _CertificateSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Certificates description: The CertificateEnvironments that belong to this project KeyPairEnvironments: type: array items: type: object properties: KeyPairTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _KeyPairSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Key Pairs description: The KeyPair Environments that belong to this project CSPEnvironments: type: array items: type: object properties: CSPTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for CSP description: The CSP Environments that belong to this project GPGEnvironments: type: array items: type: object properties: GPGTemplate: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _GPGSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for GPG description: The GPG Environments that belong to this project DotNetEnvironments: type: array items: type: object properties: DotNetTemplate: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Gets the _DotNetSignEnvironmentTemplate_ relating to this environment StatusMessage: type: string description: Gets the status message of an environment Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this environment format: int64 Dn: type: string description: Gets the object DN for this environment TemplateDN: type: string description: Gets the DN of the template this environment was created from CertificateGroupingId: type: integer description: Gets the grouping id to use with all logs related to the associated key format: int32 RequireJustification: type: boolean description: Gets or sets if justification is required to use the key Type: type: string description: '' KeyUseFlowDN: type: string description: Gets or sets the DN of the Flow to apply for Key Use AllowUserKeyImport: type: boolean description: /Gets or sets a flag indicating users can import their own keys for use in a PerUser environment PreventUseOfExpiredEnvironment: type: boolean description: Gets or sets a flag indicating if expired objects contained by this environment are accessible for use. IPAddressRestriction: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of client IP restrictions to use the associated key CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attributes and values FriendlyName: type: string description: A friendly name/label for this environment KeyTimeConstraints: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of time constraint DNs for this environment Status: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' description: Class that provides Sign environment for Dot Net description: The .NET Environments that belong to this project Owners: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are owners of this project Auditors: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are auditors of this project KeyUseApprovers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are key use approvers for this project KeyUsers: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The users that are approved for private key use for this project CustomFieldAttributes: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings properties: Added: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were added since the last sync Removed: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: object properties: FieldName: type: string description: The Custom Field's label name Values: type: array items: type: string description: The Custom Field's values Type: $ref: '#/components/schemas/Core_MetadataType' description: Class containing Code Signing Custom Field settings description: List of items description: The Custom Field attibutes and values description: Signing Project WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProject: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProjectStatus: required: - ProjectStatus type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing project. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\[YourPrjName]*.' Guid: type: string description: Object GUID Id: type: integer description: Object ID format: int64 ProjectStatus: $ref: '#/components/schemas/CodeSigning_SignProjectStatus' WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProjectStatus: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteProject: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the Code Signing Project. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\[YourProject]*.' Guid: type: string description: The globally unique identifier of the Code Signing Project object. Id: type: integer description: The signing project identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteProject: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RenameProject: required: - NewDn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing project. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\[YourPrjName]*.' Guid: type: string description: The GUID that uniquely identifies the signing project. Id: type: integer description: The signing project identifier. format: int64 NewDn: type: string description: 'The DN of the signing project. Use this syntax: *Dn: \\VED\\Code Signing\\Projects\\[ProjectName]*.' WebSDK_Product_CodeSigning_CodeSigningResponse_RenameProject: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateTemplates: type: object properties: Filter: type: string description: The template name. WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateTemplates: type: object properties: AppleTemplates: type: array items: type: object properties: TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizationalunit attribute. CNPattern: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template value for the regex pattern to be used to identify acceptable certificates based on the CN CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Apple Signing Driver template wrapper description: An array of Apple environment templates, if any. CertificateTemplates: type: array items: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Certificate Signing Driver template wrapper description: An array of Certificate environment template, if any. CSPTemplates: type: array items: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Signing PKIX Parameter Set Policy attribute. EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Encryption PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Signing environment template for the CSP Signing Environment description: An array of CSP environment templates, if any. DotNetTemplates: type: array items: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Signing environment template for the DotNet strongname signing environment description: An array of DotNet environment templates, if any. GPGTemplates: type: array items: type: object properties: IsIssuer: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Denotes that this environment cannot sign, encrypt or authenticate, only issue child keys AllowOptionalKeys: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Determines whether the authentication key and/or encryption key can be optional or not RealName: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the RealName attribute. Email: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Email attribute. Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. SigningKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SigningKeyAlgorithm attribute. EncryptionKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. AuthenticationKeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the EncryptionKeyAlgorithm attribute. SigningPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Signing PKIX Parameter Set Policy attribute EncryptionPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Encryption PKIX Parameter Set Policy attribute AuthenticationPkixParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for Authentication PKIX Parameter Set Policy attribute KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Signing environment template for the GPG Sign Environment description: An array of GPG environment templates, if any. KeyPairTemplates: type: array items: type: object properties: Expiration: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Expiration attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyStorageLocation attribute. KeyContainerDN: type: string description: Gets or sets the value for the Key Container DN attribute. Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Signing environment template for the KeyPair Sign Environment description: An array of KeyPair environment templates, if any. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetTemplate: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment template. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Environment Templates\\[YourTemplateName]*.' Guid: type: string description: The GUID that uniquely identifies the Environment template. Id: type: integer description: The Environment Template identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetTemplate: type: object properties: CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: The Certificate environment template. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CreateTemplate: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Projects\\PrjName\\[YourEnvName]*.' PerUser: type: boolean description: 'Immutable. The mode that supports multiple cryptographic objects to use for signing. Applies only to *Code Signing Certificate Environment Template* and *Code Signing GPG Environment Template*. - *true*: Store signing Certificate objects in the Policy Tree by a user''s identity. - *false*: Default.Projects that use this template allow the key pairs that are required by the environment.Multiple signers use the same cryptographic objects.One Certificate object for this template.No macro filtering.' TemplateType: type: string description: 'One of the following encryption methods for signing code: - Code Signing Apple Environment Template - Code Signing Certificate Environment Template - Code Signing CSP Environment Template - Code Signing DotNet Environment Template - Code Signing Key Pair Environment Template - Code Signing GPG Environment Template' WebSDK_Product_CodeSigning_CodeSigningResponse_CreateTemplate: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateTemplate: required: - Dn - CertificateTemplate - ObjectNamingPattern type: object properties: Dn: type: string description: 'The Distinguished Name(DN) of the environment template.Use the appropriate syntax.For example, in Postman: *\\VED\\Code Signing\\Environment Templates\\[YourTemplateName]*. To get this value, call POST Codesign/EnumerateTemplates.' CertificateTemplate: type: object properties: CertificateSubject: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the X509 Subject attribute. City: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the City attribute. State: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the State attribute. Country: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Country attribute. Organization: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organization attribute. OrganizationalUnit: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the Organizational Unit attribute. CertificateAuthorityDN: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the CertificateAuthorityDN attribute. KeyAlgorithm: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the KeyAlgorithm attribute. PKIXParameterSetPolicy: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the PKIX Parameter Set Policy attribute. SANEmail: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets or sets the template values for the SANEmail attribute. TargetPolicyDN: type: string description: Gets or sets the template values for the CertificateContainerDN attribute. AllowEmailSANs: type: boolean description: Gets a flag indicating that the environment can have email sans KeyStorageLocation: type: object properties: Value: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: The value of this attribute Info: $ref: '#/components/schemas/CodeSigning_SignTemplateValueInfo' description: Gets the list of possible Key Storage Location values to be used when creating a certificate Guid: type: string description: Gets a globally unique identifier that identifies this environment Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project VisibleTo: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of users that are allowed to view this template description: Certificate Environment Template WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateTemplate: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteTemplate: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment template. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Environment Templates\\[YourTemplateName]*.' Force: type: boolean description: 'The setting to control deletion while the template is in use: *true*: Force deletion even if the template is in use. *false*: Retain the template if it is in use.' Guid: type: string description: The GUID that uniquely identifies the Environment template. Id: type: integer description: The Environment Template identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteTemplate: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RenameTemplate: required: - NewDn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment template. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Environment Templates\\[YourTemplateName]*.' Guid: type: string description: The GUID that uniquely identifies the Environment template. NewDn: type: string description: The new DN to identify the new Template name. Use the same syntax as *Dn*. WebSDK_Product_CodeSigning_CodeSigningResponse_RenameTemplate: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplications: type: object properties: Filter: type: string description: The partial tool name and optional trailing asterisk (/*) wild card. For example, *Powershell**. WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplications: type: object properties: Applications: type: array items: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Data class containing Code Signing Application configuration description: The array of SignApplicationCollections. The attributes that appear depend on the application settings. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplication: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing application. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnApp]*.' Guid: type: string description: The GUID that uniquely identifies the signing application. Id: type: integer description: The signing application identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplication: type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: The array of SignApplicationCollections. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplication: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name(DN) of the signing application.Use the appropriate syntax.For example, in Postman: *\VED\\Code Signing\\Signing Applications\\[YourSgnApp]*.' WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplication: type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: A code signing applications Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplication: required: - Application type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Application WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplication: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplication: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing application. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnApp]*.' Guid: type: string description: The GUID that uniquely identifies the signing application. Id: type: integer description: The signing application identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplication: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplication: required: - Dn - NewDn type: object properties: Dn: type: string description: 'The Distinguished Name(DN) of the signing application.Use the appropriate syntax.For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnApp]*. To get this value, call POST Codesign/EnumerateApplications.' NewDn: type: string description: The new DN to identify the signing application. WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplication: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CountReferences: type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Application ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Application WebSDK_Product_CodeSigning_CodeSigningResponse_CountReferences: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateReferences: type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: Application ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Application ApplicationDn: type: string description: 'Show the location of a signing application.Specify the DN of the signing application.Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnApp]. To get the value, call POST Codesign/GetApplication*.' ApplicationGuid: type: string description: Show the location of a signing application. Specify the GUID that uniquely identifies the signing application. To get The GUID that uniquely identifies the signing application. The value, call POST Codesign/GetApplication. CollectionDn: type: string description: 'Show the location of an application collection.Specify just the application collection DN.Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*. To get the value, call POST Codesign/EnumerateApplicationCollections.' CollectionGuid: type: string description: The GUID that uniquely identifies a set of application signing tools.To get the value, call POST Codesign/EnumerateApplicationCollections. WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateReferences: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' ReferenceDNs: type: array items: type: string description: An array of DNs of the application or ApplicationCollection that describes signing tools. Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplicationCollections: type: object properties: Filter: type: string description: The partial tool name and optional trailing asterisk (\*) wild card. For example, *Sign\**. WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplicationCollections: type: object properties: ApplicationCollections: type: array items: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: Data class containing Code Signing Application Collection configuration description: An array of ApplicationCollection. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollection: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*.' Guid: type: string description: The GUID that uniquely defines a collection of signing tools. Id: type: integer description: The application collection identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollection: type: object properties: ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: The set of application signing tools that are present in theApplicationCollection. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMemberDNs: type: object properties: Application: type: object properties: Dirty: type: boolean description: Gets a value indicating this object has pending changes to save Guid: type: string description: Gets a globally unique identifier that identifies this application Id: type: integer description: Gets the unique identifier for this project format: int64 Dn: type: string description: Gets the object DN for this project Description: type: string description: The description of this application Size: type: integer description: Gets or sets the size of the signing application binary format: int64 Hash: type: string description: Gets or sets the SHA256 Hash of the application binary SignatorySubject: type: string description: Gets or sets the X.500 Subject DN of the certificate used to sign the application SignatoryIssuer: type: string description: Gets or sets the X.500 Issuer DN of the certificate used to sign the application Version: type: string description: Gets or sets the version that matches this application Location: type: string description: Gets or sets the location this application resides on disk SigningObjectFileArgumentPattern: type: string description: Gets or sets the regular expression pattern to pick out the file name of the binary being signed by the application CommandRestrictionRegex: type: string description: Gets or sets the regular expression pattern to enforce the command line of the application description: The Application object for Code Sign Manager that is currently part of a collection. Dn: type: string description: 'The Distinguished Name (DN) of a set of signing applications. Use this syntax: *\\VED\\Code Signing\\Signing Applications\\[SgnApp]*.' Guid: type: string description: The GUID that uniquely identifies the signing application. Id: type: integer description: The signing application identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMemberDNs: type: object properties: ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: The description of the ApplicationCollection container. ApplicationCollectionDNs: type: array items: type: string description: An array of Application object for Code Sign Manager that describe signing tools. ApplicationDNs: type: array items: type: string description: An array of Application object for Code Sign Manager that describe signing tools. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMembers: type: object properties: Dn: type: string description: 'The Distinguished Name(DN) of a set of signing applications.Use this syntax: *\\VED\\Code Signing\\Signing Applications\\[SgnApp]*.' Guid: type: string description: The GUID that uniquely identifies the signing application. Id: type: integer description: The signing application identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMembers: type: object properties: ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: The ApplicationCollection that holds this member. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplicationCollection: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the new signing collection. Use this syntax: *\\VED\\Code Signing\\Signing Applications\\[collection name]*.' WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplicationCollection: type: object properties: ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: The ApplicationCollection that holds this member. Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplicationCollection: required: - ApplicationCollection type: object properties: ApplicationCollection: type: object properties: Guid: type: string description: Gets a globally unique identifier that identifies this application collection Id: type: integer description: Gets the unique identifier for this signing application collection format: int64 Dn: type: string description: Gets the object DN for this application collection description: The entire ApplicationCollection. To get this value, call POST Codesign/EnumerateApplicationCollections. WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplicationCollection: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplicationCollection: type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*.' Guid: type: string description: 'The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*.' Id: type: integer description: The signing application identifier. format: int64 WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplicationCollection: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplicationCollection: required: - Dn - NewDn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the signing collection. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*. To get this value, call POST Codesign/EnumerateApplicationCollections.' NewDn: type: string description: The new DN to identify the set of signing tools. WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplicationCollection: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningResponse_GetGlobalConfiguration: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. GlobalConfiguration: type: object properties: AvailableKeyStorageLocations: type: array items: type: string description: Gets all available key storage locations DefaultCAContainer: type: string description: Gets the default certificate authority container DefaultCertificateContainer: type: string description: Gets the default certificate container DefaultCredentialContainer: type: string description: Gets the default credential container EnforceGroupRoles: type: boolean description: Gets a flag indicating that only groups may be selected for roles on a project KeyUseTimeout: type: integer description: Gets a value indicating how many seconds a client should wait for a response when attempting to use a key. format: int64 ArchiveRetention: type: integer description: Gets a value indicating how many days archive should wait before expiring entries. format: int64 MaxEnvironmentCount: type: integer description: Gets a value indicating the maximum number of environments to allow for a single key user format: int64 MaximumSupportedClientVersion: type: string description: Gets the maximum client version supported. MinimumSupportedClientVersion: type: string description: Gets the maximum client version supported. UseClientPublicEndpoints: type: boolean description: Gets a flag indicating if the client should download updates from public endpoints. PreventSelfDealing: type: boolean description: Gets a flag indicating the a key user on a project may not be a member if any other Role DisableSigningArchive: type: boolean description: Gets a flag indicating the Disable Status of the Signing Archive PreventUnlimitedSignings: type: boolean description: The flag indicating if Signing Flow approvals can allow unlimited signings. ProjectDeleteFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be deleted ProjectUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be updated ProjectCreateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be created EnvironmentCreateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be create EnvironmentUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be updated EnvironmentDeleteFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be deleted EnvironmentTemplateUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment Template is updated RequestInProgressMessage: type: string description: Gets a value holding the message to be returned in response to a code signing request if flow prevents immediate execution FlowInstanceMacro: type: string description: Gets a value holding the macro that defines how to determine uniqueness of a client request ApprovedKeyStorageLocations: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of key storage locations that are approved for use with code signing description: Global Configuration Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_SetGlobalConfiguration: required: - GlobalConfiguration type: object properties: GlobalConfiguration: type: object properties: AvailableKeyStorageLocations: type: array items: type: string description: Gets all available key storage locations DefaultCAContainer: type: string description: Gets the default certificate authority container DefaultCertificateContainer: type: string description: Gets the default certificate container DefaultCredentialContainer: type: string description: Gets the default credential container EnforceGroupRoles: type: boolean description: Gets a flag indicating that only groups may be selected for roles on a project KeyUseTimeout: type: integer description: Gets a value indicating how many seconds a client should wait for a response when attempting to use a key. format: int64 ArchiveRetention: type: integer description: Gets a value indicating how many days archive should wait before expiring entries. format: int64 MaxEnvironmentCount: type: integer description: Gets a value indicating the maximum number of environments to allow for a single key user format: int64 MaximumSupportedClientVersion: type: string description: Gets the maximum client version supported. MinimumSupportedClientVersion: type: string description: Gets the maximum client version supported. UseClientPublicEndpoints: type: boolean description: Gets a flag indicating if the client should download updates from public endpoints. PreventSelfDealing: type: boolean description: Gets a flag indicating the a key user on a project may not be a member if any other Role DisableSigningArchive: type: boolean description: Gets a flag indicating the Disable Status of the Signing Archive PreventUnlimitedSignings: type: boolean description: The flag indicating if Signing Flow approvals can allow unlimited signings. ProjectDeleteFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be deleted ProjectUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be updated ProjectCreateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when a Project or Environment is to be created EnvironmentCreateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be create EnvironmentUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be updated EnvironmentDeleteFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment is to be deleted EnvironmentTemplateUpdateFlowDN: type: string description: Gets a value containing the Flow DN to be processed when an Environment Template is updated RequestInProgressMessage: type: string description: Gets a value holding the message to be returned in response to a code signing request if flow prevents immediate execution FlowInstanceMacro: type: string description: Gets a value holding the macro that defines how to determine uniqueness of a client request ApprovedKeyStorageLocations: type: array items: type: string properties: Added: type: array items: type: string description: Gets the items that were added since the last sync Removed: type: array items: type: string description: Gets the items that were removed since the last sync Dirty: type: boolean description: Returns **true** if an item in the collection was added, removed or changed Items: type: array items: type: string description: List of items description: Gets the list of key storage locations that are approved for use with code signing description: 'The set of Policy tree locations and user settings:' WebSDK_Product_CodeSigning_CodeSigningResponse_SetGlobalConfiguration: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_AddAdministrator: required: - Trustee type: object properties: Trustee: type: string description: The PrefixedUniversal identity. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_AddAdministrator: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveAdministrator: required: - Trustee type: object properties: Trustee: type: string description: The PrefixedUniversal identity of a person or group. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveAdministrator: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_AddApplicationAdministrator: required: - Trustee type: object properties: Trustee: type: string description: The *PrefixedUniversal* identity. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_AddApplicationAdministrator: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveApplicationAdministrator: required: - Trustee type: object properties: Trustee: type: string description: The *PrefixedUniversal* identity of a person or group. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveApplicationAdministrator: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_AddProjectApprover: required: - Trustee type: object properties: Trustee: type: string description: The *PrefixedUniversal* identity of a person or group. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_AddProjectApprover: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveProjectApprover: required: - Trustee type: object properties: Trustee: type: string description: The *PrefixedUniversal* identity of a person or group. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveProjectApprover: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetRight: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of an object. Use the appropriate syntax. For example, in Postman: * Application: \\VED\\Code Signing\\Signing Applications\\[YourSgnApp]. * ApplicationCollection: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]. * Project: \\VED\\Code Signing\\Projects\\[YourPrjName].' WebSDK_Product_CodeSigning_CodeSigningResponse_GetRight: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Rights: $ref: '#/components/schemas/CodeSigning_SignRight' Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetTrusteeRights: required: - Trustee type: object properties: Trustee: type: string description: The *PrefixedUniversal* identity. To get the value, call POST Identity/Browse. WebSDK_Product_CodeSigning_CodeSigningResponse_GetTrusteeRights: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_GetObjectRights: required: - Dn type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of an object. Use the appropriate syntax. For example, in Postman: Application: *\\VED\\Code Signing\\Signing Applications\\[YourSgnApp]*. ApplicationCollection: *\\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]*. Project: *\\VED\\Code Signing\\Projects\\[YourPrjName]*.' WebSDK_Product_CodeSigning_CodeSigningResponse_GetObjectRights: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_AddPreApproval: required: - User - Comment - NotBefore - Hours - SingleUse type: object properties: Dn: type: string description: 'The Distinguished Name (DN) of the environment template. Use the appropriate syntax. For example, in Postman: *\\VED\\Code Signing\\Environment Templates\\[YourTemplateName]*.' User: type: string description: The key user in which the pre approval should be applied to. Should be in the format of PrefixedName *(e.g. AD:User1)* Comment: type: string description: The comment from the pre-approval indicating why this is being created. NotBefore: type: string description: 'DateTime of when the pre-approval should being. Format: 2023-01-01 08:00 AM' IPAddress: type: string description: In CIDR notation SigningExecutable: type: string description: The .exe of the signing tool used Hours: type: integer description: 'Amount of time the pre-approval should be valid. Example: 72' format: int32 SingleUse: type: boolean description: Should only allow a single signing WebSDK_Product_CodeSigning_CodeSigningResponse_AddPreApproval: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RunMacro: required: - Dn - MacroIdentity - Macros - EnvironmentType type: object properties: Dn: type: string description: Object DN MacroIdentity: type: string description: Identity to use for RunMacro Macros: type: array items: type: string description: List of macros to use for RunMacro EnvironmentType: type: string description: Type of an environment to use for RunMacro WebSDK_Product_CodeSigning_CodeSigningResponse_RunMacro: type: object properties: Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. Result: $ref: '#/components/schemas/CodeSigning_SignResult' Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_RetrieveArchiveEntries: type: object properties: ArchiveFilter: type: object properties: IsSigningRequestAction: type: boolean description: Filter for all statuses that involve key use approval IsSigningFailure: type: boolean description: Filter for all statuses that are considered signing failtures IsSigningSystemError: type: boolean description: Filter for all status errors that are not considered user violations IsSigningViolation: type: boolean description: Filter for all status errors that are considered user violations IsSigningArchiveSettingsChange: type: boolean description: Filter for signing archive settings changes (e.g. enable/disable archive events) TimestampAfter: type: string description: After Timestamp TimestampBefore: type: string description: Before Timestamp EventTypeId: type: string description: EventTypeId in hex format ApplicationHash: type: string description: Application Hash for application allowed for signing Artifact: type: string description: The Artifact AuthenticatedUser: type: string description: Authenticated User who performed the cryptographic operation AuthenticatedUserName: type: string description: Authenticated User Name who performed the cryptographic operation ClientInterface: type: integer description: Client Interface format: int32 ClientLibraryLocation: type: string description: Client Library Location in the file system ClientLibraryName: type: string description: Client Library Name ClientLibraryVersion: type: string description: Client Library Version ClientMechanism: type: integer description: Client Mechanism format: int32 Executable: type: string description: Executable ExecutableLocation: type: string description: Executable Location IPAddress: type: string description: Ip Address of the machine or device performing the cryptographic operation Command: type: string description: Command used to execute the cryptographic operation KeyType: type: string description: Key Type KeyVaultId: type: integer description: Key Vault Id format: int64 Machine: type: string description: Machine name used for the cryptographic operation Mechanism: type: integer description: Mechanism used for the cryptographic operation format: int32 Platform: type: string description: Platform OS RemoteAccount: type: string description: Remote User Account ProjectDN: type: string description: Project Object DN ProjectName: type: string description: Project Object Name ProjectDNs: type: array items: type: string description: Project Objects DNs ProjectId: type: integer description: Project Object format: int64 ProjectIds: type: array items: type: integer format: int64 description: Project Objects EnvironmentDN: type: string description: Environment Object DN EnvironmentName: type: string description: Environment Object Name EnvironmentDNs: type: array items: type: string description: Environment Objects DNs EnvironmentId: type: integer description: Environment Id of the environment used for used for the cryptographic operation format: int64 EnvironmentIds: type: array items: type: integer format: int64 description: Environment Objects FlowDN: type: string description: Flow Object DN FlowName: type: string description: Flow Object Name FlowId: type: integer description: Flow Object format: int64 ArchiveEntryId: type: integer description: Archive Entry Id for the cryptographic operation record format: int64 Grouping: type: integer description: Grouping format: int32 FreeTextFilter: type: string description: Free text filter for filtering using multiple fields description: Filter Dictionary for Archive Filtering PageSize: type: integer description: Pagination Page Size format: int32 Page: type: integer description: Pagination Requested Page format: int32 WebSDK_Product_CodeSigning_CodeSigningResponse_RetrieveArchiveEntries: type: object properties: ArchiveResults: type: array items: type: object properties: Timestamp: type: string description: Timestamp EventTypeId: type: string description: EventTypeId in hexadecimal format EventType: type: string description: EventType string based on EventTypeId ApplicationHash: type: string description: Application Hash Artifact: type: string description: Artfact AuthenticatedUser: type: string description: Authenticated User AuthenticatedUserName: type: string description: Authenticated User Name ClientInterface: type: integer description: Client Interface format: int32 ClientLibraryLocation: type: string description: Client Library Location ClientLibraryName: type: string description: Client Library Name ClientLibraryVersion: type: string description: Client Library Version ClientMechanism: type: integer description: Client Mechanism format: int64 Executable: type: string description: Executable ExecutableLocation: type: string description: Executable Location IPAddress: type: string description: Ip Address Command: type: string description: Command KeyType: type: string description: Key Type KeyVaultId: type: integer description: Key Vault Id format: int64 Machine: type: string description: Machine Mechanism: type: integer description: Mechanism format: int64 Platform: type: string description: Platform OS RemoteAccount: type: string description: Remote User Account Project: type: string description: Project Object Environment: type: string description: Environment Object Flow: type: string description: Flow Object ArchiveEntryId: type: integer description: Archive Entry Id format: int64 Grouping: type: integer description: Grouping format: int32 description: Class to represent a CodeSigning request for the product REST API description: List of returned archive results PageNumber: type: integer description: Page of Paginated results format: int32 TotalCount: type: integer description: Total Count format: int64 Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' WebSDK_Product_CodeSigning_CodeSigningRequest_ExportSignArchive: type: object properties: ArchiveFilter: type: object properties: IsSigningRequestAction: type: boolean description: Filter for all statuses that involve key use approval IsSigningFailure: type: boolean description: Filter for all statuses that are considered signing failtures IsSigningSystemError: type: boolean description: Filter for all status errors that are not considered user violations IsSigningViolation: type: boolean description: Filter for all status errors that are considered user violations IsSigningArchiveSettingsChange: type: boolean description: Filter for signing archive settings changes (e.g. enable/disable archive events) TimestampAfter: type: string description: After Timestamp TimestampBefore: type: string description: Before Timestamp EventTypeId: type: string description: EventTypeId in hex format ApplicationHash: type: string description: Application Hash for application allowed for signing Artifact: type: string description: The Artifact AuthenticatedUser: type: string description: Authenticated User who performed the cryptographic operation AuthenticatedUserName: type: string description: Authenticated User Name who performed the cryptographic operation ClientInterface: type: integer description: Client Interface format: int32 ClientLibraryLocation: type: string description: Client Library Location in the file system ClientLibraryName: type: string description: Client Library Name ClientLibraryVersion: type: string description: Client Library Version ClientMechanism: type: integer description: Client Mechanism format: int32 Executable: type: string description: Executable ExecutableLocation: type: string description: Executable Location IPAddress: type: string description: Ip Address of the machine or device performing the cryptographic operation Command: type: string description: Command used to execute the cryptographic operation KeyType: type: string description: Key Type KeyVaultId: type: integer description: Key Vault Id format: int64 Machine: type: string description: Machine name used for the cryptographic operation Mechanism: type: integer description: Mechanism used for the cryptographic operation format: int32 Platform: type: string description: Platform OS RemoteAccount: type: string description: Remote User Account ProjectDN: type: string description: Project Object DN ProjectName: type: string description: Project Object Name ProjectDNs: type: array items: type: string description: Project Objects DNs ProjectId: type: integer description: Project Object format: int64 ProjectIds: type: array items: type: integer format: int64 description: Project Objects EnvironmentDN: type: string description: Environment Object DN EnvironmentName: type: string description: Environment Object Name EnvironmentDNs: type: array items: type: string description: Environment Objects DNs EnvironmentId: type: integer description: Environment Id of the environment used for used for the cryptographic operation format: int64 EnvironmentIds: type: array items: type: integer format: int64 description: Environment Objects FlowDN: type: string description: Flow Object DN FlowName: type: string description: Flow Object Name FlowId: type: integer description: Flow Object format: int64 ArchiveEntryId: type: integer description: Archive Entry Id for the cryptographic operation record format: int64 Grouping: type: integer description: Grouping format: int32 FreeTextFilter: type: string description: Free text filter for filtering using multiple fields description: Filter Dictionary for Archive Filtering PageSize: type: integer description: Pagination Page Size format: int32 Page: type: integer description: Pagination Requested Page format: int32 BeforeEntryId: type: integer description: '' format: int64 SkipCsvHeader: type: boolean description: '' WebSDK_Product_CodeSigning_CodeSigningRequest_Create: type: object properties: Dn: type: string description: Object DN User: type: string description: A prefixed user universal, or prefixed name Comment: type: string description: A comment for an operation Data: type: string description: A base64 encoded data blob SingleUse: type: boolean description: Indicates a pre approval should disappear after use IPAddress: type: string description: The IP Address to be used with a pre-approval SigningExecutable: type: string description: The signing executable to be used with a pre-approval Hours: type: integer description: A number of hours format: int32 WebSDK_Product_CodeSigning_CodeSigningResponse_Create: type: object properties: Success: type: boolean description: 'The result of this API call: A value of **false** indicates the request failed due to an **Error**. Otherwise, **true**.' Result: $ref: '#/components/schemas/CodeSigning_SignResult' Error: type: string description: Appears only when **Success** is **false**. An error message that accompanies the **Result**. Check your payload input values. WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_create: required: - CredentialType - CredentialPath - ConnectorPath type: object properties: CustomFields: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The custom fields to be passed to the Adaptable Credential script ConnectorName: type: string description: The name of the Adaptable Credential Connector to use CredentialType: type: string description: The type of credential that the script will return CredentialPath: type: string description: The path of the Adaptable Credential to update or create WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_create: type: object properties: Error: type: string description: /// Gets or sets the error. WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_update: required: - CustomFields - CredentialType - CredentialPath - ConnectorPath type: object properties: CustomFields: type: array items: type: object properties: Name: type: string description: The name. Value: type: string description: The value. description: Holds a string/object value pair description: The custom fields to be passed to the Adaptable Credential script ConnectorName: type: string description: The name of the Adaptable Credential Connector to use CredentialType: type: string description: The type of credential that the script will return CredentialPath: type: string description: The path of the Adaptable Credential to update or create WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_update: type: object properties: Error: type: string description: /// Gets or sets the error. WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest: type: object properties: ConnectorName: type: string description: The name of the CyberArk Credential Connector to use CyberArkUsername: type: string description: Gets or sets the CyberArk username. CyberArkPassword: type: string description: Gets or sets the CyberArk password. Username: type: string description: "Gets or sets the username.\r\nIf this property is present in the request (even if empty or null),\ \ a UsernamePassword credential is created.\r\nIf this property is not present in the request, a Password-only\ \ credential is created." AppID: type: string description: Gets or sets the application ID. SafeName: type: string description: Gets or sets the safe name. FolderName: type: string description: Gets or sets the folder name. AccountName: type: string description: Gets or sets the account name. DualAccount: type: string description: "Gets or sets the dual account mode.\r\nAccepts boolean (true/false) or string values (\"1\"/\"0\"\ , \"true\"/\"false\")." VirtualUserName: type: string description: Gets or sets the virtual user name Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. NewCredentialPath: type: string description: The new distinguished name (DN) path for the credential after renaming. Pattern: type: string description: A pattern string used to match credential names. Recursive: type: boolean description: '**true** if the search should include subcontainers; otherwise, **false**.' description: CyberArk credentials web request. WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse: type: object properties: Username: type: string description: Gets or sets the username. Password: type: string description: Gets or sets the password. AppID: type: string description: Gets or sets the application ID. SafeName: type: string description: Gets or sets the safe name. FolderName: type: string description: Gets or sets the folder name. AccountName: type: string description: Gets or sets the account name. Error: type: string description: Gets or sets the error. Shared: type: boolean description: '**true** if shown when browsing for credentials; otherwise, **false**.' Contact: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The contact. Expiration: type: string description: Expiration date of the credential (in MS Dateime JSON format - milliseconds since 1/1/1970) EncryptionKey: type: string description: The encryption key. Description: type: string description: The description. FriendlyName: type: string description: The friendly name. Classname: type: string description: The classname. CredentialInfos: type: array items: type: object properties: ClassName: type: string description: Gets/sets the config class name FullName: type: string description: Gets/sets the full path and name of the credential description: Class describing a credential item description: The credential infos. Values: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: '' description: The description. Result: $ref: '#/components/schemas/Core_CredentialResult' description: CyberArk credentials web response. Web_Hsm_HsmJWTRequest_signjwt: required: - ClientInfo - ProcessInfo - KeyId - Header - Payload type: object properties: ClientInfo: type: object properties: ClientLibraryName: type: string description: The Library Name used to make the request ClientLibraryVersion: type: string description: The version of the client library ClientLibraryLocation: type: string description: The location of the client library description: Details about the client making the request. ProcessInfo: type: object properties: Executable: type: string description: The executable invoking the crypto operation ExecutableSigner: type: string description: The signer of the requesting executable ExecutableIssuer: type: string description: The issuer of the requesting executable's authenticode certificate ExecutableSize: type: integer description: The size of the requesting executable format: int64 ExecutableHash: type: string description: The hash of the requesting executable CommandLine: type: string description: The command line invoked for this crypto request Username: type: string description: The (login account) name of the user making the request Machine: type: string description: The machine the request is made from Platform: type: string description: The OS Platform the request is made from ClientTime: type: string description: 'Timestamp from the client in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ' RequestId: type: string description: A 16-byte (null terminated) random string used as a request identifier description: Information about the process triggering the request. KeyId: type: string description: The environment to use for the cryptographic operation. Header: type: string description: The data (in Base64 encoding) the cryptographic operation is applied to. Payload: type: string description: The data (in Base64 encoding) the cryptographic operation is applied to. Web_Hsm_HsmJWTResponse_signjwt: type: object properties: ResultData: type: string description: The resulting token of the cryptographic operation. Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Web_Hsm_HsmBaseResponse_IsHsm: type: object properties: vedauth: type: string description: Returns the URL that should be used for authentication requests pks: type: string description: Returns the URL of the public key server (/pks) timestamp: type: string description: Returns the URL of the timestamp server (/timestamp) csc: type: string description: Returns the URL of the client distribution page (/csc) Web_Hsm_HsmCryptoRequest_sign: required: - ClientInfo - Data - KeyContext - KeyId - Mechanism - ProcessInfo type: object properties: ClientInfo: type: object properties: ClientLibraryName: type: string description: The Library Name used to make the request ClientLibraryVersion: type: string description: The version of the client library ClientLibraryLocation: type: string description: The location of the client library description: Details about the client making the request. ClientMechanism: type: integer description: Use only when the server requires a different Mechanism. For example, when signing and hashing on the client side, set this field to describe the actual mechanism for a full operation (when signing this would include the digest). format: int32 Data: type: string description: The data (in Base64 encoding) the cryptographic operation is applied to. Justification: type: string description: A justification for the operation. KeyContext: type: string description: The context (if an environment holds more than one key) to use for the operation. KeyContextToWrap: type: string description: For wrapping operations, the Context of the key to wrap. KeyId: type: string description: The environment to use for the cryptographic operation. Mechanism: type: integer description: The Mechanism ID that represents the encryption algorithm for signing the software. For Rsa Pkcs, specify 1. To get additional values, use the LibHSM documentation on your signing workstation. See md_Documentation_RESTCrypto.html. format: int32 Parameter: type: object properties: ParameterType: type: string description: String indicating the parameter type IVLength: type: integer description: IV Length, needs to be set for Encrypt format: int32 IV: type: string description: IV, encoded in Base64, needs to be set for Decrypt AAD: type: string description: AAD, encoded in Base64 HashAlg: type: integer description: Hash Algorithm format: int32 KDF: type: integer description: Key Derivation Function format: int32 MGF: type: integer description: Mask Generation Function format: int32 Source: type: integer description: Source of the encoding parameter format: int32 SourceData: type: string description: The base64 representation of the data used as the input for the encoding parameter source HmacKeyData: type: string description: The base64 representation of the HMAC key to use for key derivation PrependData: type: string description: The base64 representation of the data prepended for key derivation AppendData: type: string description: The base64 representation of the data appended for key derivation SharedData: type: string description: The base64 representation of the shared data used for key derivation PublicData: type: string description: The base64 representation of the key derivation public data SaltLen: type: integer description: Length, in bytes, of the salt used format: int32 HedgeVariant: type: integer description: Hedge Required value for AdditionalContext _CryptokiHedgeType_ format: int32 ContextData: type: string description: The base64 representation of the context data Mechanism: type: integer description: Mechanism used for Pre-Hash signing format: int32 description: Parameters for the specific cryptographic operation. Password: type: string description: For 2FA, the password. ProcessInfo: type: object properties: Executable: type: string description: The executable invoking the crypto operation ExecutableSigner: type: string description: The signer of the requesting executable ExecutableIssuer: type: string description: The issuer of the requesting executable's authenticode certificate ExecutableSize: type: integer description: The size of the requesting executable format: int64 ExecutableHash: type: string description: The hash of the requesting executable CommandLine: type: string description: The command line invoked for this crypto request Username: type: string description: The (login account) name of the user making the request Machine: type: string description: The machine the request is made from Platform: type: string description: The OS Platform the request is made from ClientTime: type: string description: 'Timestamp from the client in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ' RequestId: type: string description: A 16-byte (null terminated) random string used as a request identifier description: Information about the process triggering the request. Username: type: string description: For 2FA, the username. VerifyData: type: string description: For verifying operations, the data to verify against. In Base64 encoding. WrappingKeyId: type: string description: For wrapping operations, the KeyId of the key to wrap with. Web_Hsm_HsmCryptoResponse: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: Returns the error that occurred if the operation was not successful. TryLater: type: boolean description: '**true** if the operation was not performed due to a flow condition that requires to resend the request at a later time.' RequestThumbprint: type: string description: Includes the Flow Process Instance Identification digest, in case the operation is blocked by a Flow that requires approval. ResultData: type: string description: The result of the cryptographic operation, in Base64 format. description: Data object for a cryptographic operation response. Web_Hsm_HsmCryptoRequest_decrypt: required: - KeyId - Data type: object properties: KeyId: type: string description: The DN of the environment or the GUID. Data: type: string description: The public key data needed for decryption. Web_Hsm_HsmCryptoResponse_decrypt: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: 'Appears only when there is an error. Possible reasons include: * Missing or invalid KeyID' TryLater: type: boolean description: '**true** if the operation was not performed due to a flow condition that requires to resend the request at a later time.' ResultData: type: string description: The result of the cryptographic operation, in Base64 format. Web_Hsm_HsmCryptoRequest_derive: required: - KeyId - Mechanism - Data type: object properties: KeyId: type: string description: The KeyId will be the DN or GUID of the environment to created the derivation for. Mechanism: type: integer description: 'The Mechanism ID that represents the encryption algorithm. The only mechanisms supported for derivation are EC and ECDH. **NOTE: You will need to include the parameters defiend by mechanism.**' format: int32 Data: type: string description: The public key info used to create the derivation. Web_Hsm_HsmCryptoResponse_derive: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: 'Appears only when there is an error. Possible reasons include: * Missing or invalid KeyID' TryLater: type: boolean description: '**true** if the operation was not performed due to a flow condition that requires to resend the request at a later time.' ResultData: type: string description: The result of the cryptographic operation, in Base64 format. Web_Hsm_HsmGpgRequest_getgpgpublickey: required: - KeyId type: object properties: KeyId: type: string description: "The GUID that uniquely identifies the GPG environment. The Key ID allows the WKS to retrieve the GPG\ \ public key for signing of electronic information.\r\nTo get the value, use the **Guid** from the POST Codesign/GetEnvironment\ \ response." KeyContext: type: string description: The context (if an environment holds more than one key) to use for the operation. Web_Hsm_HsmGpgResponse_getgpgpublickey: type: object properties: Fingerprint: type: string description: The GPG fingerprint of the key. Location: type: string description: The public URI of the GPG public key document for the key. PublicKey: type: string description: The GPG public key, in Base64 format. Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Web_Hsm_HsmStoreRequest_storeobject: required: - KeyId - KeyCreationTimestamp - KeyContext - PublicKey - PrivateKey - PrivateKeyPassword type: object properties: KeyId: type: string description: The environment to use for the cryptographic operation. KeyCreationTimestamp: type: string description: The context (if an environment holds more than one key) to use for the operation. KeyContext: type: string description: The context (if an environment holds more than one key) to use for the operation. PublicKey: type: string description: The ASN.1 PublicKey structure (in Base64 encoding) of the key to upload PrivateKey: type: string description: The PKCS#8 ASN.1 PrivateKey structure (in Base64 encoding) of the key to upload PrivateKeyPassword: type: string description: The passphrase that was used to encrypt the PKCS#8 private key. Web_Hsm_HsmStoreResponse: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: Returns the error that occurred if the operation was not successful. description: Data object for an object retrieval response. Web_Hsm_HsmObjectRequest_getchain: type: object properties: KeyId: type: string description: The key in which to get the certificate chain for. Web_Hsm_HsmObjectResponse_getchain: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: Returns the error that occurred if the operation was not successful. Certificates: type: array items: type: object properties: Trusted: type: boolean description: '**true** if the certificate is considered trusted.' TargetStore: type: string description: The store the certificate should be placed in on the client; **null** for "My" CACert: type: boolean description: '**true** if the certificate is a root or intermediate certificate.' Value: type: string description: The DER-encoded certificate. CheckValue: type: string description: The first three bytes of the SHA-1 hash of the certificate object’s Value attribute, encoded in Base64. StartDate: type: string description: Valid-From date for the certificate, in yyyyMMdd format. EndDate: type: string description: Valid-To date for the certificate, in yyyyMMdd format. Subject: type: string description: The DER-encoded X.500 Subject of the certificate, in Base64 format. Issuer: type: string description: The DER-encoded X.500 Issuer of the certificate, in Base64 format. EnvironmentType: type: integer description: "The type of the environment where this object exists in. Takes LibHsmEnv types:\r\n0-Certificate,\ \ 1-GPG, 2-.Net, 3-CSP, 4-KeyPair, 5-SecretKey, 6-Apple" format: int32 KeyId: type: string description: The Environment GUID for this object. CreatedOn: type: string description: The ISO8601 date/time the object was created. KeyContext: type: string description: The key context if the environment holds more than one keypair. Authentication: type: boolean description: '**true** if the object is intended for authentication purposes.' Signing: type: boolean description: '**true** if the object is intended for signing/verification purposes.' Encipherment: type: boolean description: '**true** if the object is intended for encryption/decryption purposes.' Handle: type: integer description: The server-side handle of the object. Not all objects will have non-zero handle values. format: int64 ObjectType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiObjectType' Label: type: string description: The label of the object. Id: type: string description: The ID of the object, in Base64 format. Copyable: type: boolean description: True if the object store allows the object to be copied. Modifiable: type: boolean description: True if the object store allows the object to be modified. Private: type: boolean description: True if the object is private and only visible after authentication. Token: type: boolean description: True if the object lives on a token. All Code Sign Manager objects are considered on-token unless they are pending. Pending: type: boolean description: True if the object has not yet been issued. description: HSM certificate object. description: List of certificate objects. Web_Hsm_HsmObjectRequest_getobjects: type: object properties: EnvironmentFilter: type: array items: type: integer format: int32 description: "An array of comma separated HSM EnvironmentTypes. A single environment can contain up to three public\ \ and private keys and certificates. If an environment contains more than one keypair, the KeyContext identifies\ \ the purpose of the key:\r\n* 0 = Certificate environment.A single certificate and keypair.\r\n* 1 = GNU Privacy\ \ Guard (GPG) environment. Three keypairs (sign, encrypt, auth) and optional certificates.\r\n* 2 = .Net Strongname\ \ environment.No certificate; RSA only.\r\n* 3 = Cryptographic Service Provider (CSP). Two key pairs (sign and\ \ encrypt), certificates optional.\r\n* Example: \"EnvironmentFilter\": [1,2]" IncludeArchived: type: boolean description: '**true** if archived objects (previous objects, since expired or renewed) should be returned as well.' IncludeChains: type: boolean description: '**true** if intermediate and root objects for certificates being returned should be included as well.' KeyId: type: string description: The environment relevant to the request, or **null**. LabelFilter: type: array items: type: string description: If provided, limits the returned objects to objects whose Label matches one of the specified pattern. ObjectTypeFilter: type: array items: type: integer format: int32 description: List of object types to return. If not provided, all object types will be returned. Expects Pkcs#11/Cryptoki CKO_ object types. Web_Hsm_HsmObjectResponse_getobjects: type: object properties: Certificates: type: array items: type: object properties: Trusted: type: boolean description: '**true** if the certificate is considered trusted.' TargetStore: type: string description: The store the certificate should be placed in on the client; **null** for "My" CACert: type: boolean description: '**true** if the certificate is a root or intermediate certificate.' Value: type: string description: The DER-encoded certificate. CheckValue: type: string description: The first three bytes of the SHA-1 hash of the certificate object’s Value attribute, encoded in Base64. StartDate: type: string description: Valid-From date for the certificate, in yyyyMMdd format. EndDate: type: string description: Valid-To date for the certificate, in yyyyMMdd format. Subject: type: string description: The DER-encoded X.500 Subject of the certificate, in Base64 format. Issuer: type: string description: The DER-encoded X.500 Issuer of the certificate, in Base64 format. EnvironmentType: type: integer description: "The type of the environment where this object exists in. Takes LibHsmEnv types:\r\n0-Certificate,\ \ 1-GPG, 2-.Net, 3-CSP, 4-KeyPair, 5-SecretKey, 6-Apple" format: int32 KeyId: type: string description: The Environment GUID for this object. CreatedOn: type: string description: The ISO8601 date/time the object was created. KeyContext: type: string description: The key context if the environment holds more than one keypair. Authentication: type: boolean description: '**true** if the object is intended for authentication purposes.' Signing: type: boolean description: '**true** if the object is intended for signing/verification purposes.' Encipherment: type: boolean description: '**true** if the object is intended for encryption/decryption purposes.' Handle: type: integer description: The server-side handle of the object. Not all objects will have non-zero handle values. format: int64 ObjectType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiObjectType' Label: type: string description: The label of the object. Id: type: string description: The ID of the object, in Base64 format. Copyable: type: boolean description: True if the object store allows the object to be copied. Modifiable: type: boolean description: True if the object store allows the object to be modified. Private: type: boolean description: True if the object is private and only visible after authentication. Token: type: boolean description: True if the object lives on a token. All Code Sign Manager objects are considered on-token unless they are pending. Pending: type: boolean description: True if the object has not yet been issued. description: HSM certificate object. description: List of certificate objects. Pending: type: boolean description: '**true** if some objects were not returned because they are still pending creation. (e.g Certificate to be issued by a CA)' PrivateKeys: type: array items: type: object properties: Sensitive: type: boolean description: '**true** if the key is sensitive.' Decrypt: type: boolean description: '**true** if the key can be used for decryption.' Sign: type: boolean description: '**true** if the key can be used for signing.' SignRecover: type: boolean description: '**true** if the key can be used for signing where the data can recovered from the signature.' Unwrap: type: boolean description: '**true** if the key can be used for unwrapping.' Extractable: type: boolean description: '**true** if the key can not be revealed in plaintext.' AlwaysSensitive: type: boolean description: '**true** if the key has always been marked _Sensitive_.' NeverExtractable: type: boolean description: '**true** if the key has never been marked _Extractable_.' Bits: type: integer description: The key size, in bits. format: int32 Modulus: type: string description: 'For **RSA** keys: The modulus, in Base64 encoding.' Exponent: type: string description: 'For **RSA** keys: The exponent, in Base64 encoding.' Curve: type: string description: 'For EC keys: The curve name.' Params: type: string description: 'For EC keys: The DER-encoding of an ANSI X9.62 **parameters** value, in Base64 encoding.' ParameterSet: type: integer description: 'For PQ keys: Type and/or Size for the key.' format: int32 nullable: true PkixParameterSet: type: string description: '' PkixParameterSetName: type: string description: '' KeyType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiKeyType' Derive: type: boolean description: '**true** if the key allows derivation.' Local: type: boolean description: '**true** if the key was generated on the token.' EnvironmentType: type: integer description: "The type of the environment where this object exists in. Takes LibHsmEnv types:\r\n0-Certificate,\ \ 1-GPG, 2-.Net, 3-CSP, 4-KeyPair, 5-SecretKey, 6-Apple" format: int32 KeyId: type: string description: The Environment GUID for this object. CreatedOn: type: string description: The ISO8601 date/time the object was created. KeyContext: type: string description: The key context if the environment holds more than one keypair. Authentication: type: boolean description: '**true** if the object is intended for authentication purposes.' Signing: type: boolean description: '**true** if the object is intended for signing/verification purposes.' Encipherment: type: boolean description: '**true** if the object is intended for encryption/decryption purposes.' Handle: type: integer description: The server-side handle of the object. Not all objects will have non-zero handle values. format: int64 ObjectType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiObjectType' Label: type: string description: The label of the object. Id: type: string description: The ID of the object, in Base64 format. Copyable: type: boolean description: True if the object store allows the object to be copied. Modifiable: type: boolean description: True if the object store allows the object to be modified. Private: type: boolean description: True if the object is private and only visible after authentication. Token: type: boolean description: True if the object lives on a token. All Code Sign Manager objects are considered on-token unless they are pending. Pending: type: boolean description: True if the object has not yet been issued. description: Object representing a private key. description: List of private key objects. PublicKeys: type: array items: type: object properties: Encrypt: type: boolean description: '**true** if the key can be used for encryption.' Verify: type: boolean description: '**true** if the key can be used for verification.' VerifyRecover: type: boolean description: '**true** if the key can be used for verification where the data is recovered from the signature.' Wrap: type: boolean description: '**true** if the key can be used for wrapping.' Bits: type: integer description: The key size, in bits. format: int32 Modulus: type: string description: 'For **RSA** keys: The modulus, in Base64 encoding.' Exponent: type: string description: 'For **RSA** keys: The exponent, in Base64 encoding.' Curve: type: string description: 'For EC keys: The curve name.' Params: type: string description: 'For EC keys: The DER-encoding of an ANSI X9.62 **parameters** value, in Base64 encoding.' Value: type: string description: 'For PQ Keys: The DER-encoding of the public key, in Base64 encoding' ParameterSet: type: integer description: 'For PQ keys: Type and/or Size for the key.' format: int32 nullable: true ECPoint: type: string description: 'For EC keys: The DER-encoding of an ANSI X9.62 **ECPoint** value Q, in Base64 encoding. (The public key)' PkixParameterSet: type: string description: '' PkixParameterSetName: type: string description: '' KeyType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiKeyType' Derive: type: boolean description: '**true** if the key allows derivation.' Local: type: boolean description: '**true** if the key was generated on the token.' EnvironmentType: type: integer description: "The type of the environment where this object exists in. Takes LibHsmEnv types:\r\n0-Certificate,\ \ 1-GPG, 2-.Net, 3-CSP, 4-KeyPair, 5-SecretKey, 6-Apple" format: int32 KeyId: type: string description: The Environment GUID for this object. CreatedOn: type: string description: The ISO8601 date/time the object was created. KeyContext: type: string description: The key context if the environment holds more than one keypair. Authentication: type: boolean description: '**true** if the object is intended for authentication purposes.' Signing: type: boolean description: '**true** if the object is intended for signing/verification purposes.' Encipherment: type: boolean description: '**true** if the object is intended for encryption/decryption purposes.' Handle: type: integer description: The server-side handle of the object. Not all objects will have non-zero handle values. format: int64 ObjectType: $ref: '#/components/schemas/Core_Cryptography_Cryptoki_CryptokiObjectType' Label: type: string description: The label of the object. Id: type: string description: The ID of the object, in Base64 format. Copyable: type: boolean description: True if the object store allows the object to be copied. Modifiable: type: boolean description: True if the object store allows the object to be modified. Private: type: boolean description: True if the object is private and only visible after authentication. Token: type: boolean description: True if the object lives on a token. All Code Sign Manager objects are considered on-token unless they are pending. Pending: type: boolean description: True if the object has not yet been issued. description: Object representing a public key. description: List of public key objects. Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Web_Hsm_HsmTelemetryRequest: type: object properties: ClientInfo: type: object properties: ClientLibraryName: type: string description: The Library Name used to make the request ClientLibraryVersion: type: string description: The version of the client library ClientLibraryLocation: type: string description: The location of the client library description: Details about the client making the request. ProcessInfo: type: object properties: Executable: type: string description: The executable invoking the crypto operation ExecutableSigner: type: string description: The signer of the requesting executable ExecutableIssuer: type: string description: The issuer of the requesting executable's authenticode certificate ExecutableSize: type: integer description: The size of the requesting executable format: int64 ExecutableHash: type: string description: The hash of the requesting executable CommandLine: type: string description: The command line invoked for this crypto request Username: type: string description: The (login account) name of the user making the request Machine: type: string description: The machine the request is made from Platform: type: string description: The OS Platform the request is made from ClientTime: type: string description: 'Timestamp from the client in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ' RequestId: type: string description: A 16-byte (null terminated) random string used as a request identifier description: Information about the process triggering the request. ClientOperation: type: string description: The operation that failed (i.e. sign, login, getobjects). ClientOperationError: type: string description: The message from the client to be recorded. KeyLabel: type: string description: The Label relevant to the request, or **null**. KeyId: type: string description: The Key ID relevant to the request, or **null**. LabelFilter: type: array items: type: string description: The LabelFilters relevant to the request as a list of string, or **null**. description: Data object for sending code sign client telemetry. Web_Hsm_HsmTelemetryResponse: type: object properties: Success: type: boolean description: '**true** if the operation was successful, **false** otherwise.' Error: type: string description: Returns the error that occurred if the operation was not successful. description: Data object for a telemetry submission response. ClientWebSDK_DataContracts_BulkRequest: type: object properties: Clients: type: array items: type: object properties: ClientId: type: string description: Client ID ClientType: type: string description: Client type ClientVersion: type: string description: Client Version TrustLevel: type: string description: Trust level Groups: type: array items: type: string description: Group DNs EffectiveWork: type: array items: type: string description: Applicable Work DNs CreatedOn: type: string description: Create On (ISO 8601) LastSeenOn: type: string description: Client last seen (ISO 8601) Username: type: string description: Username Hostname: type: string description: Hostname HostDomain: type: string description: Domain DnsName: type: string description: DNS Name FQDN: type: string description: Fully qualified domain name VirtualMachineId: type: string description: Virtual machine ID Region: type: string description: Region code Networks: type: array items: type: object properties: IpAddress: type: string description: IP address MacAddress: type: string description: MAC address description: Holds information about client record that will be send to ClientWebSDK API consumers description: Networks OsBuild: type: string description: OS build version OsName: type: string description: OS name OsServicePack: type: string description: OS service pack version OsVersion: type: string description: Operating system version SerialNumber: type: string description: Serial number SystemArchitecture: type: string description: System architecture SystemChassis: type: string description: System chassis type SystemManufacturer: type: string description: System manufacturer SystemModel: type: string description: System model CertificateDevice: type: string description: Certificate device DN SshDevice: type: string description: Ssh device DN description: Client Detail description: List of clients (5000 max) DeleteAssociatedDevices: type: boolean description: Flag indicating, on delete, whether to also delete associated devices description: Request to perform bulk operation ClientWebSDK_DataContracts_DeleteResponse_delete: type: object properties: DeletedCount: type: integer description: Number of deleted items format: int32 Core_WebSDK_AlgorithmSelectorWebRequest_get: required: - ObjectDN type: object properties: ObjectDN: type: string description: The distinguished name of the requested object Core_WebSDK_AlgorithmSelectorWebResponse_get: type: object properties: Selector: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: The Algorithm Selector Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_commit: required: - ObjectDN - PKIXParameterSet type: object properties: ObjectDN: type: string description: The distinguished name of the requested object PKIXParameterSet: type: string description: The Venafi PKIX Parameter Set Oid identifying an algorithm Core_WebSDK_AlgorithmSelectorWebResponse_commit: type: object properties: Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_find: required: - AlgorithmStrength type: object properties: AlgorithmStrength: type: integer description: The strength of algorithms to be returned. Algorithms not matching the strength will be filtered out format: int32 nullable: true IncludeStronger: type: boolean description: "If **true** algorithms with a strength greater than _AlgorithmStrength_,\r\nor a category greater\ \ than _AlgorithmCategory_, will also be returned" Core_WebSDK_AlgorithmSelectorWebResponse_find: type: object properties: Selectors: type: array items: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: '' description: The Algorithm Selectors Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_getpolicy: required: - ObjectDN - SchemaClass type: object properties: ObjectDN: type: string description: The distinguished name of the requested object SchemaClass: type: string description: The schema class where algorithm selector policy is applied Core_WebSDK_AlgorithmSelectorWebResponse_getpolicy: type: object properties: Selectors: type: array items: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: '' description: The Algorithm Selectors Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_commitpolicy: required: - ObjectDN - SchemaClass - PKIXParameterSets type: object properties: ObjectDN: type: string description: The distinguished name of the requested object SchemaClass: type: string description: The schema class where algorithm selector policy is applied PKIXParameterSets: type: array items: type: string description: A list of Venafi PKIX Parameter Set Oid identifying an algorithm Core_WebSDK_AlgorithmSelectorWebResponse_commitpolicy: type: object properties: Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_getselector: required: - PKIXParameterSet type: object properties: PKIXParameterSet: type: string description: The Venafi PKIX Parameter Set Oid identifying an algorithm Core_WebSDK_AlgorithmSelectorWebResponse_getselector: type: object properties: Selector: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: The Algorithm Selector Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebResponse_getallselectors: type: object properties: Selectors: type: array items: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: '' description: The Algorithm Selectors Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_getallowedalgorithms: required: - ObjectDN type: object properties: ObjectDN: type: string description: The distinguished name of the requested object SchemaClass: type: string description: The schema class where algorithm selector policy is applied Core_WebSDK_AlgorithmSelectorWebResponse_getallowedalgorithms: type: object properties: Selectors: type: array items: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: '' description: The Algorithm Selectors Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebResponse_getglobalalgorithms: type: object properties: Selectors: type: array items: type: object properties: Algorithm: type: string description: Gets the display name for the selected algorithm PkixParameterSetOid: type: string description: Gets the Venafi Pkix Parameter Set Oid for the selected algorithm Description: type: string description: Gets the description text for the selected algorithm StrengthCategory: $ref: '#/components/schemas/Core_PkixNISTStrengthCategory' description: '' description: The Algorithm Selectors Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_AlgorithmSelectorWebRequest_setglobalalgorithms: required: - PKIXParameterSets type: object properties: PKIXParameterSets: type: array items: type: string description: A list of Venafi PKIX Parameter Set Oid identifying an algorithm Core_WebSDK_AlgorithmSelectorWebResponse_setglobalalgorithms: type: object properties: Success: type: boolean description: True if the request was successful Error: type: string description: The error associated with the request Core_WebSDK_FlowTicketRequest_enumerate: required: - ProductCode - TicketPageSize - TicketPageNumber type: object properties: ProductCode: type: integer description: "The product code used to filter which tickets are visible.\r\n## Values and Behaviors ##\r\n\r\n|Value|Description|\r\ \n|---|---|\r\n|Specific code|Filter on a specific product code. For example the integer 0x60020001 will filter\ \ down to tickets for Code Signing Key Use Flows.|\r\n|Component only|Filter on a particular component. The component\ \ is represented by the high bits in the integer. For example the integer 0x60020000 will interact with any Flow\ \ in the Code Signing component, including all product codes from 0x60020001 through 0x6002FFFF|\r\n|Zero (0)|Providing\ \ a zero for this value will not filter the results.|" format: int32 TicketPageSize: type: integer description: The page size of tickets to be enumerated format: int32 TicketPageNumber: type: integer description: The page number of tickets to be enumerated format: int32 Core_WebSDK_FlowTicketResponse_enumerate: type: object properties: Tickets: type: array items: type: object properties: Id: type: integer description: The unique identifier of this ticket format: int64 FlowId: type: integer description: The reference to its parent Flow configuration format: int64 RequiredApprovals: type: integer description: Gets the minimum number of approvals required before this ticket is approved format: int32 CreationTime: type: string description: The time this ticket was created RemainingUses: type: integer description: Gets the remaining number of uses at the time of creation if the ticket has been approved. If **null** the ticket use is unlimited format: int32 nullable: true NotBefore: type: string description: '' nullable: true ExpiresOn: type: string description: The ticket has been approved and can be used until this date. If **null** the ticket does not expire. nullable: true Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: Gets the list of prefixed universals of users/groups who can approve this ticket Approvals: type: array items: type: object properties: Universal: type: string description: The prefixed universal of the user that supplied this approval Comment: type: string description: The optional comment left by the user ApprovalTime: type: string description: The time that this approval was issued description: Information about a specific ticket approval description: Gets the list of prefixed universals of users who have approved the request FlowProcessId: type: integer description: The Id of the process blocked by this ticket format: int64 Identifier: type: string description: The identifier string of the process ProductCode: type: integer description: Gets the product code of the flow that created this ticket format: int32 Environment: type: object additionalProperties: type: string description: Value description: 'The current environment variables of the process blocked by this ticket **Key**: Environment Name' PriorEnvironment: type: object additionalProperties: type: string description: Value description: 'The most recent set of environment variables of previous processes that have utilizied this ticket **Key**: Environment Name' RejectionStatus: $ref: '#/components/schemas/Core_FlowTicketRejectionStatus' RejectionComment: type: string description: Gets the rejection comment if the ticket has been rejected description: A ticket inside the FlowTickets system description: The flow tickets. Message: type: string description: The error. Core_WebSDK_FlowTicketRequest_enumerateapproved: required: - ProductCode - TicketPageSize - TicketPageNumber type: object properties: ProductCode: type: integer description: "The product code used to filter which tickets are visible.\r\n## Values and Behaviors ##\r\n\r\n|Value|Description|\r\ \n|---|---|\r\n|Specific code|Filter on a specific product code. For example the integer 0x60020001 will filter\ \ down to tickets for Code Signing Key Use Flows.|\r\n|Component only|Filter on a particular component. The component\ \ is represented by the high bits in the integer. For example the integer 0x60020000 will interact with any Flow\ \ in the Code Signing component, including all product codes from 0x60020001 through 0x6002FFFF|\r\n|Zero (0)|Providing\ \ a zero for this value will not filter the results.|" format: int32 TicketPageSize: type: integer description: The page size of tickets to be enumerated format: int32 TicketPageNumber: type: integer description: The page number of tickets to be enumerated format: int32 Core_WebSDK_FlowTicketResponse_enumerateapproved: type: object properties: Tickets: type: array items: type: object properties: Id: type: integer description: The unique identifier of this ticket format: int64 FlowId: type: integer description: The reference to its parent Flow configuration format: int64 RequiredApprovals: type: integer description: Gets the minimum number of approvals required before this ticket is approved format: int32 CreationTime: type: string description: The time this ticket was created RemainingUses: type: integer description: Gets the remaining number of uses at the time of creation if the ticket has been approved. If **null** the ticket use is unlimited format: int32 nullable: true NotBefore: type: string description: '' nullable: true ExpiresOn: type: string description: The ticket has been approved and can be used until this date. If **null** the ticket does not expire. nullable: true Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: Gets the list of prefixed universals of users/groups who can approve this ticket Approvals: type: array items: type: object properties: Universal: type: string description: The prefixed universal of the user that supplied this approval Comment: type: string description: The optional comment left by the user ApprovalTime: type: string description: The time that this approval was issued description: Information about a specific ticket approval description: Gets the list of prefixed universals of users who have approved the request FlowProcessId: type: integer description: The Id of the process blocked by this ticket format: int64 Identifier: type: string description: The identifier string of the process ProductCode: type: integer description: Gets the product code of the flow that created this ticket format: int32 Environment: type: object additionalProperties: type: string description: Value description: 'The current environment variables of the process blocked by this ticket **Key**: Environment Name' PriorEnvironment: type: object additionalProperties: type: string description: Value description: 'The most recent set of environment variables of previous processes that have utilizied this ticket **Key**: Environment Name' RejectionStatus: $ref: '#/components/schemas/Core_FlowTicketRejectionStatus' RejectionComment: type: string description: Gets the rejection comment if the ticket has been rejected description: A ticket inside the FlowTickets system description: The flow tickets. Message: type: string description: The error. Core_WebSDK_FlowTicketRequest_approve: required: - Comment type: object properties: Comment: type: string description: A comment to apply to the approval or rejection UseCount: type: integer description: The maximum number of times the ticket may be used before a new ticket is required. Default is null to allow an unlimited number of times the ticket can be reused. format: int32 nullable: true NotBefore: type: string description: The optional earliest time the ticket may be used. ISO 8601 (YYYY-MM-DDTHH:mm:ssZ) format Expires: type: string description: The optional latest time the ticket may be used before the approval expires and a new ticket is required. ISO 8601 (YYYY-MM-DDTHH:mm:ssZ) format TicketIds: type: array items: type: integer format: int64 description: A collection of unique flow ticket IDs. Ticket IDs are can be obtained via Enumerate. TicketId: type: integer description: A unique identifier for a flow ticket. A ticket ID can be obtained via Enumerate. format: int64 Core_WebSDK_FlowTicketResponse_approve: type: object properties: Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Core_WebSDK_FlowTicketRequest_reject: required: - Comment - RejectionLevel type: object properties: Comment: type: string description: A comment to apply to the approval or rejection RejectionLevel: $ref: '#/components/schemas/Core_FlowTicketRejectionStatus' TicketIds: type: array items: type: integer format: int64 description: A collection of unique flow ticket IDs. Ticket IDs are can be obtained via Enumerate. TicketId: type: integer description: A unique identifier for a flow ticket. A ticket ID can be obtained via Enumerate. format: int64 Core_WebSDK_FlowTicketResponse_reject: type: object properties: Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Core_WebSDK_FlowTicketRequest_count: type: object properties: ProductCode: type: integer description: "The product code used to filter which tickets are visible.\r\n## Values and Behaviors ##\r\n\r\n|Value|Description|\r\ \n|---|---|\r\n|Specific code|Filter on a specific product code. For example the integer 0x60020001 will filter\ \ down to tickets for Code Signing Key Use Flows.|\r\n|Component only|Filter on a particular component. The component\ \ is represented by the high bits in the integer. For example the integer 0x60020000 will interact with any Flow\ \ in the Code Signing component, including all product codes from 0x60020001 through 0x6002FFFF|\r\n|Zero (0)|Providing\ \ a zero for this value will not filter the results.|" format: int32 Core_WebSDK_FlowTicketResponse_count: type: object properties: Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Count: type: integer description: A count of objects format: int32 Core_WebSDK_FlowTicketRequest_countapproved: type: object properties: ProductCode: type: integer description: "The product code used to filter which tickets are visible.\r\n## Values and Behaviors ##\r\n\r\n|Value|Description|\r\ \n|---|---|\r\n|Specific code|Filter on a specific product code. For example the integer 0x60020001 will filter\ \ down to tickets for Code Signing Key Use Flows.|\r\n|Component only|Filter on a particular component. The component\ \ is represented by the high bits in the integer. For example the integer 0x60020000 will interact with any Flow\ \ in the Code Signing component, including all product codes from 0x60020001 through 0x6002FFFF|\r\n|Zero (0)|Providing\ \ a zero for this value will not filter the results.|" format: int32 Core_WebSDK_FlowTicketResponse_countapproved: type: object properties: Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Count: type: integer description: A count of objects format: int32 Core_WebSDK_FlowTicketRequest_load: required: - TicketId type: object properties: TicketId: type: integer description: A unique identifier for a flow ticket. A ticket ID can be obtained via Enumerate. format: int64 Core_WebSDK_FlowTicketResponse_load: type: object properties: Ticket: type: object properties: Id: type: integer description: The unique identifier of this ticket format: int64 FlowId: type: integer description: The reference to its parent Flow configuration format: int64 RequiredApprovals: type: integer description: Gets the minimum number of approvals required before this ticket is approved format: int32 CreationTime: type: string description: The time this ticket was created RemainingUses: type: integer description: Gets the remaining number of uses at the time of creation if the ticket has been approved. If **null** the ticket use is unlimited format: int32 nullable: true NotBefore: type: string description: '' nullable: true ExpiresOn: type: string description: The ticket has been approved and can be used until this date. If **null** the ticket does not expire. nullable: true Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: Gets the list of prefixed universals of users/groups who can approve this ticket Approvals: type: array items: type: object properties: Universal: type: string description: The prefixed universal of the user that supplied this approval Comment: type: string description: The optional comment left by the user ApprovalTime: type: string description: The time that this approval was issued description: Information about a specific ticket approval description: Gets the list of prefixed universals of users who have approved the request FlowProcessId: type: integer description: The Id of the process blocked by this ticket format: int64 Identifier: type: string description: The identifier string of the process ProductCode: type: integer description: Gets the product code of the flow that created this ticket format: int32 Environment: type: object additionalProperties: type: string description: Value description: 'The current environment variables of the process blocked by this ticket **Key**: Environment Name' PriorEnvironment: type: object additionalProperties: type: string description: Value description: 'The most recent set of environment variables of previous processes that have utilizied this ticket **Key**: Environment Name' RejectionStatus: $ref: '#/components/schemas/Core_FlowTicketRejectionStatus' RejectionComment: type: string description: Gets the rejection comment if the ticket has been rejected description: A Flow Ticket Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Core_WebSDK_FlowTicketRequest_update: required: - Comment type: object properties: Comment: type: string description: A comment to apply to the approval or rejection UseCount: type: integer description: The maximum number of times the ticket may be used before a new ticket is required. Default is null to allow an unlimited number of times the ticket can be reused. format: int32 nullable: true NotBefore: type: string description: The optional earliest time the ticket may be used. ISO 8601 (YYYY-MM-DDTHH:mm:ssZ) format Expires: type: string description: The optional latest time the ticket may be used before the approval expires and a new ticket is required. ISO 8601 (YYYY-MM-DDTHH:mm:ssZ) format TicketIds: type: array items: type: integer format: int64 description: A collection of unique flow ticket IDs. Ticket IDs are can be obtained via Enumerate. TicketId: type: integer description: A unique identifier for a flow ticket. A ticket ID can be obtained via Enumerate. format: int64 Core_WebSDK_FlowTicketResponse_update: type: object properties: Result: $ref: '#/components/schemas/Core_FlowTicketResult' Message: type: string description: The error. Core_WebSDK_Obsolete_VersionResponse: type: object properties: Version: type: string description: Current engine version. description: Class for platform version response. Core_WebSDK_Obsolete_UpgradeStatusResponse: type: object properties: UpgradeInProgress: type: boolean description: Indicates if upgrade is in progress nullable: true Error: type: string description: Error description description: Upgrade status response Core_WebSDK_Obsolete_UpgradeSummaryResponse: type: object properties: UpgradeSummary: type: object properties: Status: type: string description: Overall system upgrade status StatusDetails: type: string description: Overall system upgrade status details UpgradeStartTime: type: string description: System upgrade start time UpgradeStopTime: type: string description: System upgrade stop time RemainingTasks: type: integer description: Number of remaining tasks for the system upgrade format: int32 nullable: true CompletedTasks: type: integer description: Number of completed tasks for the system upgrade format: int32 nullable: true OriginVersion: type: string description: Product version prior to the most recent system upgrade TargetVersion: type: string description: Target product version EnginesComplete: type: integer description: Number of engines that have completed the upgrade format: int32 nullable: true EnginesRunning: type: integer description: Number of engines that are running the upgrade format: int32 nullable: true EnginesBlocked: type: integer description: Number of engines that are blocked format: int32 nullable: true EnginesInError: type: integer description: Number of engines that are in error format: int32 nullable: true EnginesPendingInstall: type: integer description: Number of engines that are pending installation of the new version format: int32 nullable: true description: '' Error: type: string description: Error description description: Status of an upgrade Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engine: type: object properties: EngineUpgrade: type: object properties: Engine: type: object properties: DN: type: string description: The engine DN Guid: type: string description: The engine Guid DisplayName: type: string description: The engine Display Name Id: type: integer description: The engine Id format: int64 Name: type: string description: The engine Name description: Engine Details Status: type: string description: Engine upgrade status StatusDetails: type: string description: Engine upgrade status details UpgradeStartTime: type: string description: Engine upgrade start time UpgradeStopTime: type: string description: Engine upgrade stop time TaskRunning: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name StartTime: type: string description: The task start time description: The task the engine is currently working on TasksPending: type: array items: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name description: A pending task description: Upgrade tasks pending for this engine, index 0 will be the next task to be run TasksCompleted: type: array items: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name StartTime: type: string description: The task start time StopTime: type: string description: The task completion time WarningCount: type: integer description: The count of warning that occurred during execution of the task format: int64 description: A completed task description: Upgrade tasks this engine has completed, index 0 was the first completed task description: Engine Upgrade Information Error: type: string description: Error if it exists Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engines: type: object properties: Engines: type: array items: type: object properties: Engine: type: object properties: DN: type: string description: The engine DN Guid: type: string description: The engine Guid DisplayName: type: string description: The engine Display Name Id: type: integer description: The engine Id format: int64 Name: type: string description: The engine Name description: Engine Details Status: type: string description: Engine upgrade status StatusDetails: type: string description: Engine upgrade status details UpgradeStartTime: type: string description: Engine upgrade start time UpgradeStopTime: type: string description: Engine upgrade stop time TaskRunning: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name StartTime: type: string description: The task start time description: The task the engine is currently working on TasksPending: type: array items: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name description: A pending task description: Upgrade tasks pending for this engine, index 0 will be the next task to be run TasksCompleted: type: array items: type: object properties: Name: type: string description: The task name DisplayName: type: string description: The task display name StartTime: type: string description: The task start time StopTime: type: string description: The task completion time WarningCount: type: integer description: The count of warning that occurred during execution of the task format: int64 description: A completed task description: Upgrade tasks this engine has completed, index 0 was the first completed task description: Provides detailed information about the upgrade status of an individual engine description: The list of engine upgrade statuses Error: type: string description: Error if it exists Core_WebSDK_Obsolete_GroupingIdsResposne: type: object properties: UpgradeHistory: type: array items: type: object properties: Id: type: string description: Upgrade Group StartTime: type: string description: Start time of the upgrade group Versions: type: array items: type: string description: Upgrade Versions description: '' description: Upgrade Groups Error: type: string description: Error if it exists description: Grouping Ids Response Core_WebSDK_BusStatusWebResponse_getstatus: type: object properties: Success: type: boolean description: Indicates whether the request was successfully completed Status: type: object properties: ReportingEngine: type: string description: The CN of the TPP engine identity Mesh: type: boolean description: Indicates if bus operates in mesh mode MeshPort: type: integer description: The port used for bus connections format: int32 Status: type: object additionalProperties: type: array items: type: object properties: MeshDnsName: type: string description: The configured DNS name used to connect to in mesh mode EngineIdentity: type: string description: The identity of the TPP engine UnreachableBusPartners: type: array items: type: string description: "**null** if all partners are reachable or if operating in central MQTT broker mode. Otherwise,\ \ \r\na list of engine identities that aren't reachable" CurrentLatency: type: integer description: Database latency format: int32 CurrentWorkload: type: integer description: ToDo workload format: int32 StandbyMode: type: integer description: Standby mode format: int32 LoadedModules: type: array items: type: string description: If the application is Trust Protection Foundation service, the list of loaded service modules. Otherwise **null** ProcessType: type: string description: "The type of the process reporting the status.\r\nPossible values:\r\n* Application\r\n\ * Service\r\n* IIS\r\n\r\nAll valid values are defined as constants in the _ProcessTypes_ class" ProcessId: type: integer description: Gets the numerical process identifier format: int32 ProcessIdentity: type: string description: The Windows identity of the reporting application StartTimeISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format LastSeenISO8601: type: string description: The date and time (UTC) indicating when the application was last seen, in ISO-8601 format SendingHost: type: string description: The engine that generated the record SendingApplication: type: string description: The application/process the record describes NoResponse: type: boolean description: '**true** if the engine did not respond to the status request or is offline, **false** if the engine is responsive' CoreReceivedMessageCount: type: integer description: Number of messages Core has received from MQTT format: int64 CoreBackloggedMessagePeak: type: integer description: Highest number of Message Bus messages that had been received from MQTT but not yet been handled by Core format: int64 BrokerDroppedMessageCount: type: integer description: Number of Message Bus messages the broker dropped and didn't deliver because the mailbox was full format: int64 BrokerAcceptedMessageCount: type: integer description: Number of Message Bus messages the broker accepted for delivery format: int64 BrokerPendingOutgoingPeak: type: integer description: Peak number of messages the broker had pending, waiting to be sent over the network format: int64 description: Response message for bus status requests description: Connected applications description: 'A dictionary, with the engine identity as key, holding a list of status messages for each connected application **Key**: Engine identity' StatusLastUpdatedISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format description: The bus status Core_WebSDK_BusStatusWebRequest_getmeshdnsname: type: object properties: Engine: type: string description: The name of the engine whose mesh DNS name to get Core_WebSDK_BusStatusWebResponse_getmeshdnsname: type: object properties: DnsName: type: string description: The automatically detected DNS name used for connecting to the engine in mesh mode. MeshDnsName: type: string description: The configured DNS name to use when connecting to the engine in mesh mode. Success: type: boolean description: Indicates whether the request was successfully completed Status: type: object properties: ReportingEngine: type: string description: The CN of the TPP engine identity Mesh: type: boolean description: Indicates if bus operates in mesh mode MeshPort: type: integer description: The port used for bus connections format: int32 Status: type: object additionalProperties: type: array items: type: object properties: MeshDnsName: type: string description: The configured DNS name used to connect to in mesh mode EngineIdentity: type: string description: The identity of the TPP engine UnreachableBusPartners: type: array items: type: string description: "**null** if all partners are reachable or if operating in central MQTT broker mode. Otherwise,\ \ \r\na list of engine identities that aren't reachable" CurrentLatency: type: integer description: Database latency format: int32 CurrentWorkload: type: integer description: ToDo workload format: int32 StandbyMode: type: integer description: Standby mode format: int32 LoadedModules: type: array items: type: string description: If the application is Trust Protection Foundation service, the list of loaded service modules. Otherwise **null** ProcessType: type: string description: "The type of the process reporting the status.\r\nPossible values:\r\n* Application\r\n\ * Service\r\n* IIS\r\n\r\nAll valid values are defined as constants in the _ProcessTypes_ class" ProcessId: type: integer description: Gets the numerical process identifier format: int32 ProcessIdentity: type: string description: The Windows identity of the reporting application StartTimeISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format LastSeenISO8601: type: string description: The date and time (UTC) indicating when the application was last seen, in ISO-8601 format SendingHost: type: string description: The engine that generated the record SendingApplication: type: string description: The application/process the record describes NoResponse: type: boolean description: '**true** if the engine did not respond to the status request or is offline, **false** if the engine is responsive' CoreReceivedMessageCount: type: integer description: Number of messages Core has received from MQTT format: int64 CoreBackloggedMessagePeak: type: integer description: Highest number of Message Bus messages that had been received from MQTT but not yet been handled by Core format: int64 BrokerDroppedMessageCount: type: integer description: Number of Message Bus messages the broker dropped and didn't deliver because the mailbox was full format: int64 BrokerAcceptedMessageCount: type: integer description: Number of Message Bus messages the broker accepted for delivery format: int64 BrokerPendingOutgoingPeak: type: integer description: Peak number of messages the broker had pending, waiting to be sent over the network format: int64 description: Response message for bus status requests description: Connected applications description: 'A dictionary, with the engine identity as key, holding a list of status messages for each connected application **Key**: Engine identity' StatusLastUpdatedISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format description: The bus status Core_WebSDK_BusStatusWebRequest_setmeshdnsname: type: object properties: Engine: type: string description: The name of the engine whose mesh DNS name to set MeshDnsName: type: string description: The DNS name to use when attempting to connect to the engine Core_WebSDK_BusStatusWebResponse_setmeshdnsname: type: object properties: Success: type: boolean description: Indicates whether the request was successfully completed Status: type: object properties: ReportingEngine: type: string description: The CN of the TPP engine identity Mesh: type: boolean description: Indicates if bus operates in mesh mode MeshPort: type: integer description: The port used for bus connections format: int32 Status: type: object additionalProperties: type: array items: type: object properties: MeshDnsName: type: string description: The configured DNS name used to connect to in mesh mode EngineIdentity: type: string description: The identity of the TPP engine UnreachableBusPartners: type: array items: type: string description: "**null** if all partners are reachable or if operating in central MQTT broker mode. Otherwise,\ \ \r\na list of engine identities that aren't reachable" CurrentLatency: type: integer description: Database latency format: int32 CurrentWorkload: type: integer description: ToDo workload format: int32 StandbyMode: type: integer description: Standby mode format: int32 LoadedModules: type: array items: type: string description: If the application is Trust Protection Foundation service, the list of loaded service modules. Otherwise **null** ProcessType: type: string description: "The type of the process reporting the status.\r\nPossible values:\r\n* Application\r\n\ * Service\r\n* IIS\r\n\r\nAll valid values are defined as constants in the _ProcessTypes_ class" ProcessId: type: integer description: Gets the numerical process identifier format: int32 ProcessIdentity: type: string description: The Windows identity of the reporting application StartTimeISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format LastSeenISO8601: type: string description: The date and time (UTC) indicating when the application was last seen, in ISO-8601 format SendingHost: type: string description: The engine that generated the record SendingApplication: type: string description: The application/process the record describes NoResponse: type: boolean description: '**true** if the engine did not respond to the status request or is offline, **false** if the engine is responsive' CoreReceivedMessageCount: type: integer description: Number of messages Core has received from MQTT format: int64 CoreBackloggedMessagePeak: type: integer description: Highest number of Message Bus messages that had been received from MQTT but not yet been handled by Core format: int64 BrokerDroppedMessageCount: type: integer description: Number of Message Bus messages the broker dropped and didn't deliver because the mailbox was full format: int64 BrokerAcceptedMessageCount: type: integer description: Number of Message Bus messages the broker accepted for delivery format: int64 BrokerPendingOutgoingPeak: type: integer description: Peak number of messages the broker had pending, waiting to be sent over the network format: int64 description: Response message for bus status requests description: Connected applications description: 'A dictionary, with the engine identity as key, holding a list of status messages for each connected application **Key**: Engine identity' StatusLastUpdatedISO8601: type: string description: The date and time (UTC) indicating when the status was last updated, in ISO-8601 format description: The bus status Core_WebSDK_PreferenceWebResponse: type: object properties: Preferences: type: array items: type: object properties: Id: type: integer description: The identifier. format: int64 nullable: true Universal: type: string description: The universal. Product: type: string description: The product. Category: type: string description: The category. Name: type: string description: The name. Value: type: string description: The value. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' description: CyberArk User Preference Storage. description: The preferences. ResultCode: $ref: '#/components/schemas/Core_Preferences_ResultCode' description: Data class for handling preference web response Core_WebSDK_PreferenceWebRequest: type: object properties: Preferences: type: array items: type: object properties: Id: type: integer description: The identifier. format: int64 nullable: true Universal: type: string description: The universal. Product: type: string description: The product. Category: type: string description: The category. Name: type: string description: The name. Value: type: string description: The value. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' description: CyberArk User Preference Storage. description: The preferences. description: Data class for handling preference web request Core_WebSDK_RecycleBinWebRequest: type: object properties: Guid: type: string description: Gets or sets the GUID of a recycle bin item Limit: type: integer description: Gets or sets the maximum number of items to return for /getcontents format: int32 Start: type: boolean description: Gets or sets whether to start a task Stop: type: boolean description: Gets or sets whether to stop a task PurgeAll: type: boolean description: Gets or sets whether to purge all items when requesting to start a purge task Purge: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the purge process may take format: int32 After: type: integer description: Gets or sets the age, in days, an item has to be in the recycle bin before it will be purged format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the purge process **null** for any) description: Gets or sets the purge configuration options Deletion: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the deletion process may take format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the deletion process **null** for any) QuerySize: type: integer description: Gets or sets he maximum number of items to return in deletion queries format: int32 SqlTimeout: type: integer description: Gets or sets he timeout, in minutes, to use for SQL deletion queries format: int32 Tasks: type: array items: type: string description: Gets/sets deletion configuration items description: Gets or sets the purge configuration options description: Class to represent a RecycleBin request for the WebSDK Core_WebSDK_RecycleBinWebResponse_getcontents: type: object properties: Items: type: array items: type: object properties: Guid: type: string description: The GUID of the recycled item Type: type: string description: Type indicating what the deleted item is TypeDetail: type: string description: Detailed information about the type (e.g. Class if config object, vault type if vault entry) ChildCount: type: integer description: The number of children under this recycle bin item format: int32 DN: type: string description: The original DN of the item before it was deleted Name: type: string description: The original name (CN) of the item before it was deleted DeleteOn: type: string description: The Date/Time the item was deleted and moved into the recycle bin PurgeOn: type: string description: The UTC Date/Time the item is scheduled to be purged from the recycle bin, in string format DeletedBy: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The prefixed universal identity that deleted the original item RestoreState: $ref: '#/components/schemas/Core_RecycleBinRestoreState' RestorationDN: type: string description: The DN of the item when it gets restored (considers that the parent might have been renamed) description: Class representing an item in the recycle bin description: The list of items in the recycle bin Total: type: integer description: The total number of items in the recycle bin format: int32 Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_getitem: type: object properties: Guid: type: string description: Gets or sets the GUID of a recycle bin item Core_WebSDK_RecycleBinWebResponse_getitem: type: object properties: Item: type: object properties: Guid: type: string description: The GUID of the recycled item Type: type: string description: Type indicating what the deleted item is TypeDetail: type: string description: Detailed information about the type (e.g. Class if config object, vault type if vault entry) ChildCount: type: integer description: The number of children under this recycle bin item format: int32 DN: type: string description: The original DN of the item before it was deleted Name: type: string description: The original name (CN) of the item before it was deleted DeleteOn: type: string description: The Date/Time the item was deleted and moved into the recycle bin PurgeOn: type: string description: The UTC Date/Time the item is scheduled to be purged from the recycle bin, in string format DeletedBy: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The prefixed universal identity that deleted the original item RestoreState: $ref: '#/components/schemas/Core_RecycleBinRestoreState' RestorationDN: type: string description: The DN of the item when it gets restored (considers that the parent might have been renamed) description: The recycle bin item Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_getitemdetails: type: object properties: Guid: type: string description: Gets or sets the GUID of a recycle bin item Core_WebSDK_RecycleBinWebResponse_getitemdetails: type: object properties: Details: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_RecycledItemDetail_DetailType' VaultType: $ref: '#/components/schemas/Core_VaultType' SchemaClass: type: string description: Detailed information about the type (e.g. Class if config object, vault type if vault entry) DN: type: string description: The DN of the entry if a config object description: Class representing details for an item in the recycle bin description: The list of details for a single recycle bin item Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_restore: type: object properties: Guid: type: string description: Gets or sets the GUID of a recycle bin item Core_WebSDK_RecycleBinWebResponse_restore: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_purge: type: object properties: Guid: type: string description: Gets or sets the GUID of a recycle bin item Core_WebSDK_RecycleBinWebResponse_purge: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebResponse_empty: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_setconfiguration: type: object properties: Purge: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the purge process may take format: int32 After: type: integer description: Gets or sets the age, in days, an item has to be in the recycle bin before it will be purged format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the purge process **null** for any) description: Gets or sets the purge configuration options Deletion: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the deletion process may take format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the deletion process **null** for any) QuerySize: type: integer description: Gets or sets he maximum number of items to return in deletion queries format: int32 SqlTimeout: type: integer description: Gets or sets he timeout, in minutes, to use for SQL deletion queries format: int32 Tasks: type: array items: type: string description: Gets/sets deletion configuration items description: Gets or sets the purge configuration options Core_WebSDK_RecycleBinWebResponse_setconfiguration: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebResponse_getconfiguration: type: object properties: Purge: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the purge process may take format: int32 After: type: integer description: Gets or sets the age, in days, an item has to be in the recycle bin before it will be purged format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the purge process **null** for any) description: Gets or sets the purge configuration options Deletion: type: object properties: AllottedTime: type: integer description: Gets or sets the maximum number of minutes the deletion process may take format: int32 EngineDN: type: string description: Gets/sets the engine designated to run the deletion process **null** for any) QuerySize: type: integer description: Gets or sets he maximum number of items to return in deletion queries format: int32 SqlTimeout: type: integer description: Gets or sets he timeout, in minutes, to use for SQL deletion queries format: int32 Tasks: type: array items: type: string description: Gets/sets deletion configuration items description: Gets or sets the purge configuration options Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_purgetask: type: object properties: Start: type: boolean description: Gets or sets whether to start a task Stop: type: boolean description: Gets or sets whether to stop a task PurgeAll: type: boolean description: Gets or sets whether to purge all items when requesting to start a purge task Core_WebSDK_RecycleBinWebResponse_purgetask: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_RecycleBinWebRequest_deletiontask: type: object properties: Start: type: boolean description: Gets or sets whether to start a task Stop: type: boolean description: Gets or sets whether to stop a task Core_WebSDK_RecycleBinWebResponse_deletiontask: type: object properties: Result: $ref: '#/components/schemas/Core_RecycleBinResult' Error: type: string description: The error. Core_WebSDK_OAuthWebRequest_grantrole: type: object properties: GranteePrefixedUniversal: type: string description: Grantee Prefixed Universal Identity Role: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole' ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_grantrole: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_revokerole: type: object properties: GranteePrefixedUniversal: type: string description: Grantee Prefixed Universal Identity Role: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole' Core_WebSDK_OAuthWebResponse_revokerole: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebResponse_listroles: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Roles: type: array items: type: object properties: Role: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole' Grantee: type: string description: The identity this role applies to ApplicationId: type: string description: The application this role applies to (or **null** if the role isn't application-specific) description: Data class representing rights for a particular role description: Gets or sets a list roles Core_WebSDK_OAuthWebResponse_getrole: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Role: type: object properties: PermittedApplications: type: array items: type: string description: Gets the list of applications the user has rights to OwnedApplications: type: array items: type: object properties: ApplicationId: type: string description: Application ID Role: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole' description: Clean serialization for the wire description: Gets the list of applications the user owns Role: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthRole' description: Gets or sets an OAuth role Core_WebSDK_OAuthWebResponse_getconfiguration: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Configuration: type: object properties: SessionPoolSize: type: integer description: Gets or sets the WebSDK Session Pool (Cache) size, in number of entries format: int32 SessionPoolAge: type: integer description: Gets or sets the maximum time an entry can be kept in the sesion pool, in seconds format: int32 SessionPoolExpirationInterval: type: integer description: Gets or sets how often the session expiration process runs format: int32 SessionRightsRefreshInterval: type: integer description: Gets or sets the maximum number of seconds since the last request after which the stored rights of a session are refreshed from the database format: int32 StrictExpiration: type: boolean description: Gets or sets the session cache expiration strategy StatisticsApiTracking: type: boolean description: Gets or sets the if API usage is tracked via statistics StatisticsTrackingIncludesTime: type: boolean description: Gets or sets the if API usage statistics track API execution times OpenApiEnabled: type: boolean description: Gets or sets the OpenAPI documentation is accessible OpenApiUi: type: string description: Gets or sets the UI to use for OpenAPI documentation DefaultAccessTokenValidity: type: integer description: Gets or sets the number of seconds an access token is valid if not overriden by application or rule format: int32 DefaultGrantValidity: type: integer description: Gets or sets the number of seconds a grant is valid if not overriden by application or rule format: int32 DefaultGrantRefreshable: type: boolean description: Gets or sets whether or not a grant can be refreshed, if not override by application or rule UnusedAccessTokenExpiration: type: integer description: Gets or sets the number of seconds an access token must be expired to consider the grant expired, even if the actual grant expiration is further out format: int32 RefreshEndpointEnabled: type: boolean description: Gets or sets whether the token refresh endpoint is enabled AuthorizeByPassword: type: boolean description: Gets or sets whether the authentication server accepts username/password as authentication credentials AuthorizeByCertificate: type: boolean description: Gets or sets whether the authentication server accepts certificates as authentication credentials AuthorizeByIntegrated: type: boolean description: Gets or sets whether the authentication server accepts integrated (Windows) authentication AuthorizeByJwt: type: boolean description: Gets or sets whether the authentication server accepts JWT authentication AuthorizeDevice: type: boolean description: Gets or sets whether the authentication server accepts device authentication requests DeviceConfiguration: type: object properties: VerificationUri: type: string description: Gets or sets the Uri to verify (confirm) a device authorization request VerificationUriCompleteFormat: type: string description: Gets or sets the Uri to verify (confirm) a device authorization request, with a {0} placeholder for string.format use to hold the unique request id description: Gets or sets device authorization specific settings CertificateConfiguration: type: object properties: AttemptSIDExtensionBeforeSourceField: type: boolean description: Gets or sets whether we should first check and use SID extension from certificate prior to fallback to other source field SourceField: type: string description: Gets or sets the certificate field to use to determine identity AuthorizedIssuerDns: type: array items: type: string description: Gets or sets the vault IDs of the certificates trusted as issuers of certificates used to authenticate description: Gets or sets device authorization specific settings JwtConfiguration: type: object properties: ClockSkew: type: integer description: Gets or sets how much time drift is allowed for checking iat and nbf fields format: int32 CacheConfiguration: type: object properties: DegreeOfParallelism: type: integer description: Maximum number of threads that can fetch keys concurrently format: int32 RefreshDelay: type: integer description: Refresh mappings / keys delay in seconds; throttles refresh attempts format: int32 MinTtl: type: integer description: Keys minimum TTL (seconds) in the cache; after they fetched, they will live in the cache at least this amount of time format: int32 MaxTtl: type: integer description: Keys maximum TTL (seconds) in the cache; even if the keys are valid, after this amount of time they will be refreshed format: int32 Timeout: type: integer description: HTTP request timeout (for accessing JWKS URI, OIDC discovery endpoint, etc). format: int32 NoHttps: type: boolean description: If true, AuthServer allows HTTP for OIDC / JWKS endpoints. Use this option ONLY for testing purposes. NoOidcIssuerCheck: type: boolean description: If true, AuthServer skips issuer check for OpenID provider metadata. Use this option ONLY for testing purposes. AutoRefresh: type: integer description: Automatic configuration refresh interval (in seconds). AuthServer re-queries mappings from the DB and downloads keys again for each issuer. format: int32 description: JWT cache configuration description: Gets or sets JWT authorization specific settings description: Gets or sets OAuth configuration Core_WebSDK_OAuthWebRequest_setconfiguration: type: object properties: Configuration: type: object properties: SessionPoolSize: type: integer description: Gets or sets the WebSDK Session Pool (Cache) size, in number of entries format: int32 SessionPoolAge: type: integer description: Gets or sets the maximum time an entry can be kept in the sesion pool, in seconds format: int32 SessionPoolExpirationInterval: type: integer description: Gets or sets how often the session expiration process runs format: int32 SessionRightsRefreshInterval: type: integer description: Gets or sets the maximum number of seconds since the last request after which the stored rights of a session are refreshed from the database format: int32 StrictExpiration: type: boolean description: Gets or sets the session cache expiration strategy StatisticsApiTracking: type: boolean description: Gets or sets the if API usage is tracked via statistics StatisticsTrackingIncludesTime: type: boolean description: Gets or sets the if API usage statistics track API execution times OpenApiEnabled: type: boolean description: Gets or sets the OpenAPI documentation is accessible OpenApiUi: type: string description: Gets or sets the UI to use for OpenAPI documentation DefaultAccessTokenValidity: type: integer description: Gets or sets the number of seconds an access token is valid if not overriden by application or rule format: int32 DefaultGrantValidity: type: integer description: Gets or sets the number of seconds a grant is valid if not overriden by application or rule format: int32 DefaultGrantRefreshable: type: boolean description: Gets or sets whether or not a grant can be refreshed, if not override by application or rule UnusedAccessTokenExpiration: type: integer description: Gets or sets the number of seconds an access token must be expired to consider the grant expired, even if the actual grant expiration is further out format: int32 RefreshEndpointEnabled: type: boolean description: Gets or sets whether the token refresh endpoint is enabled AuthorizeByPassword: type: boolean description: Gets or sets whether the authentication server accepts username/password as authentication credentials AuthorizeByCertificate: type: boolean description: Gets or sets whether the authentication server accepts certificates as authentication credentials AuthorizeByIntegrated: type: boolean description: Gets or sets whether the authentication server accepts integrated (Windows) authentication AuthorizeByJwt: type: boolean description: Gets or sets whether the authentication server accepts JWT authentication AuthorizeDevice: type: boolean description: Gets or sets whether the authentication server accepts device authentication requests DeviceConfiguration: type: object properties: VerificationUri: type: string description: Gets or sets the Uri to verify (confirm) a device authorization request VerificationUriCompleteFormat: type: string description: Gets or sets the Uri to verify (confirm) a device authorization request, with a {0} placeholder for string.format use to hold the unique request id description: Gets or sets device authorization specific settings CertificateConfiguration: type: object properties: AttemptSIDExtensionBeforeSourceField: type: boolean description: Gets or sets whether we should first check and use SID extension from certificate prior to fallback to other source field SourceField: type: string description: Gets or sets the certificate field to use to determine identity AuthorizedIssuerDns: type: array items: type: string description: Gets or sets the vault IDs of the certificates trusted as issuers of certificates used to authenticate description: Gets or sets device authorization specific settings JwtConfiguration: type: object properties: ClockSkew: type: integer description: Gets or sets how much time drift is allowed for checking iat and nbf fields format: int32 CacheConfiguration: type: object properties: DegreeOfParallelism: type: integer description: Maximum number of threads that can fetch keys concurrently format: int32 RefreshDelay: type: integer description: Refresh mappings / keys delay in seconds; throttles refresh attempts format: int32 MinTtl: type: integer description: Keys minimum TTL (seconds) in the cache; after they fetched, they will live in the cache at least this amount of time format: int32 MaxTtl: type: integer description: Keys maximum TTL (seconds) in the cache; even if the keys are valid, after this amount of time they will be refreshed format: int32 Timeout: type: integer description: HTTP request timeout (for accessing JWKS URI, OIDC discovery endpoint, etc). format: int32 NoHttps: type: boolean description: If true, AuthServer allows HTTP for OIDC / JWKS endpoints. Use this option ONLY for testing purposes. NoOidcIssuerCheck: type: boolean description: If true, AuthServer skips issuer check for OpenID provider metadata. Use this option ONLY for testing purposes. AutoRefresh: type: integer description: Automatic configuration refresh interval (in seconds). AuthServer re-queries mappings from the DB and downloads keys again for each issuer. format: int32 description: JWT cache configuration description: Gets or sets JWT authorization specific settings description: Gets or sets OAuth configuration Core_WebSDK_OAuthWebResponse_setconfiguration: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_createapplication: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Scope: type: string description: Gets or sets the scope for an application MaximumScope: type: string description: Gets or sets the maximum scope for an application Name: type: string description: Gets or sets the name of an application Vendor: type: string description: Gets or sets the vendor of an application Description: type: string description: Gets or sets the description for an application or rule Url: type: string description: Gets or sets a url to learn more about the application AccessValidity: type: integer description: Gets or sets the duration (in seconds) access tokens should be available for format: int64 nullable: true GrantValidity: type: integer description: Gets or sets the duration (in seconds) grants should be available for format: int64 nullable: true Renewable: type: boolean description: Gets or sets whether grants for an application should be renewable nullable: true Core_WebSDK_OAuthWebResponse_createapplication: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Application: type: object properties: Name: type: string description: Gets or sets the name of the application Description: type: string description: Gets or sets the description of the application Vendor: type: string description: Gets or sets the vendor that created the application Url: type: string description: Gets or sets the URL to get more information about the application Scope: type: string description: Gets or sets the scope the application requires MaximumScope: type: string description: Gets or sets the maximum scope the application knows to use AccessValidity: type: integer description: Gets or sets the amount of time grant rules using this application should have their access token valid for format: int64 nullable: true GrantValidity: type: integer description: '**null** means the grant never expires' format: int64 nullable: true Renewable: type: boolean description: Gets or sets if grant rules created under this application should be marked for renewal nullable: true GrantCount: type: integer description: Gets or sets the number of grants issued for the application format: int32 nullable: true UserCount: type: integer description: Gets or sets the number of users having grants issued for the application format: int32 nullable: true UnusedExpiration: type: integer description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired format: int64 nullable: true ID: type: string description: Gets or sets the identifier of the application description: Gets or sets an _OAuthApplication_ Core_WebSDK_OAuthWebRequest_enumerateapplications: type: object properties: Start: type: integer description: Gets or sets the start index for paged APIs format: int32 Count: type: integer description: Gets or sets the maximum number of results to return for paged APIs format: int32 OrderBy: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField' Descending: type: boolean description: Gets or sets ordering direction for query APIs Core_WebSDK_OAuthWebResponse_enumerateapplications: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Application: type: object properties: Name: type: string description: Gets or sets the name of the application Description: type: string description: Gets or sets the description of the application Vendor: type: string description: Gets or sets the vendor that created the application Url: type: string description: Gets or sets the URL to get more information about the application Scope: type: string description: Gets or sets the scope the application requires MaximumScope: type: string description: Gets or sets the maximum scope the application knows to use AccessValidity: type: integer description: Gets or sets the amount of time grant rules using this application should have their access token valid for format: int64 nullable: true GrantValidity: type: integer description: '**null** means the grant never expires' format: int64 nullable: true Renewable: type: boolean description: Gets or sets if grant rules created under this application should be marked for renewal nullable: true GrantCount: type: integer description: Gets or sets the number of grants issued for the application format: int32 nullable: true UserCount: type: integer description: Gets or sets the number of users having grants issued for the application format: int32 nullable: true UnusedExpiration: type: integer description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired format: int64 nullable: true ID: type: string description: Gets or sets the identifier of the application description: Gets or sets an _OAuthApplication_ Core_WebSDK_OAuthWebRequest_getapplications: type: object properties: Filter: type: string description: Gets or sets a generic filter string ApplicationIds: type: array items: type: string description: Gets or sets a list of the application identifiers Core_WebSDK_OAuthWebResponse_getapplications: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Applications: type: array items: type: object properties: Name: type: string description: Gets or sets the name of the application Description: type: string description: Gets or sets the description of the application Vendor: type: string description: Gets or sets the vendor that created the application Url: type: string description: Gets or sets the URL to get more information about the application Scope: type: string description: Gets or sets the scope the application requires MaximumScope: type: string description: Gets or sets the maximum scope the application knows to use AccessValidity: type: integer description: Gets or sets the amount of time grant rules using this application should have their access token valid for format: int64 nullable: true GrantValidity: type: integer description: '**null** means the grant never expires' format: int64 nullable: true Renewable: type: boolean description: Gets or sets if grant rules created under this application should be marked for renewal nullable: true GrantCount: type: integer description: Gets or sets the number of grants issued for the application format: int32 nullable: true UserCount: type: integer description: Gets or sets the number of users having grants issued for the application format: int32 nullable: true UnusedExpiration: type: integer description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired format: int64 nullable: true ID: type: string description: Gets or sets the identifier of the application description: Holds information about a particular OAuth application description: Gets or sets a collection of _OAuthApplication_ Core_WebSDK_OAuthWebRequest_getapplication: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_getapplication: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Applications: type: array items: type: object properties: Name: type: string description: Gets or sets the name of the application Description: type: string description: Gets or sets the description of the application Vendor: type: string description: Gets or sets the vendor that created the application Url: type: string description: Gets or sets the URL to get more information about the application Scope: type: string description: Gets or sets the scope the application requires MaximumScope: type: string description: Gets or sets the maximum scope the application knows to use AccessValidity: type: integer description: Gets or sets the amount of time grant rules using this application should have their access token valid for format: int64 nullable: true GrantValidity: type: integer description: '**null** means the grant never expires' format: int64 nullable: true Renewable: type: boolean description: Gets or sets if grant rules created under this application should be marked for renewal nullable: true GrantCount: type: integer description: Gets or sets the number of grants issued for the application format: int32 nullable: true UserCount: type: integer description: Gets or sets the number of users having grants issued for the application format: int32 nullable: true UnusedExpiration: type: integer description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired format: int64 nullable: true ID: type: string description: Gets or sets the identifier of the application description: Holds information about a particular OAuth application description: Gets or sets a collection of _OAuthApplication_ Core_WebSDK_OAuthWebRequest_updateapplication: type: object properties: Application: type: object properties: Name: type: string description: Gets or sets the name of the application Description: type: string description: Gets or sets the description of the application Vendor: type: string description: Gets or sets the vendor that created the application Url: type: string description: Gets or sets the URL to get more information about the application Scope: type: string description: Gets or sets the scope the application requires MaximumScope: type: string description: Gets or sets the maximum scope the application knows to use AccessValidity: type: integer description: Gets or sets the amount of time grant rules using this application should have their access token valid for format: int64 nullable: true GrantValidity: type: integer description: '**null** means the grant never expires' format: int64 nullable: true Renewable: type: boolean description: Gets or sets if grant rules created under this application should be marked for renewal nullable: true GrantCount: type: integer description: Gets or sets the number of grants issued for the application format: int32 nullable: true UserCount: type: integer description: Gets or sets the number of users having grants issued for the application format: int32 nullable: true UnusedExpiration: type: integer description: Gets or sets the number of seconds an access token has to be expired before a grant for this application is considered expired format: int64 nullable: true ID: type: string description: Gets or sets the identifier of the application description: Gets or sets the _OAuthApplication_ to update Core_WebSDK_OAuthWebResponse_updateapplication: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_deleteapplication: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_deleteapplication: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebResponse_getscopes: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Scopes: type: array items: type: object properties: Scope: type: string description: Gets/sets the scope value RestrictionList: type: array items: type: string description: Gets/sets restrictions to the scope description: Data class to hold a single scope and its restrictions description: Gets or sets a list of scopes Core_WebSDK_OAuthWebRequest_getgrants: type: object properties: GranteePrefixedUniversal: type: string description: Grantee Prefixed Universal Identity ApplicationId: type: string description: Gets or sets the application identifier Start: type: integer description: Gets or sets the start index for paged APIs format: int32 Count: type: integer description: Gets or sets the maximum number of results to return for paged APIs format: int32 OrderBy: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField' Descending: type: boolean description: Gets or sets ordering direction for query APIs ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_getgrants: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Grants: type: array items: type: object properties: Scope: type: string description: Gets or sets the scope (WebSDK, CSP, etc) this grant applies to AccessToken: type: string description: Gets or sets the token to use to get the rights of this grant ValidFor: type: integer description: Gets or sets the number of seconds the access token is valid format: int64 AccessIssuedOn: type: string description: Gets or sets the date and time (UTC) when the access token was issued last AccessIssuedOnUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 AccessIssuedOnISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format RefreshToken: type: string description: Gets or sets the token to use to get an updated access token Expires: type: string description: Gets or sets the date and time (UTC) when the grant expires and cannot be refreshed, **null** if it does not expire nullable: true ExpiresUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 ExpiresISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format GrantIssuedOn: type: string description: Gets or sets the date and time (UTC) when the grant was issued GrantIssuedOnUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 GrantIssuedOnISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format Application: type: string description: Gets or sets the application this grant applies to GranteePrefixedUniversal: type: string description: Gets or sets the prefixed universal of the identity that was used to obtain the grant and/or grants GrantedToPrefixedUniversal: type: string description: Gets or sets the identity that the permission to obtain a grant was issued to. if the permission was assigned to the user directly) description: Holds information about a particular access grant description: Gets or sets a list of _OAuthGrant_ items Core_WebSDK_OAuthWebRequest_enumerategrants: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Start: type: integer description: Gets or sets the start index for paged APIs format: int32 Count: type: integer description: Gets or sets the maximum number of results to return for paged APIs format: int32 OrderBy: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField' Descending: type: boolean description: Gets or sets ordering direction for query APIs ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_enumerategrants: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Grants: type: array items: type: object properties: Scope: type: string description: Gets or sets the scope (WebSDK, CSP, etc) this grant applies to AccessToken: type: string description: Gets or sets the token to use to get the rights of this grant ValidFor: type: integer description: Gets or sets the number of seconds the access token is valid format: int64 AccessIssuedOn: type: string description: Gets or sets the date and time (UTC) when the access token was issued last AccessIssuedOnUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 AccessIssuedOnISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format RefreshToken: type: string description: Gets or sets the token to use to get an updated access token Expires: type: string description: Gets or sets the date and time (UTC) when the grant expires and cannot be refreshed, **null** if it does not expire nullable: true ExpiresUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 ExpiresISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format GrantIssuedOn: type: string description: Gets or sets the date and time (UTC) when the grant was issued GrantIssuedOnUnixTime: type: integer description: Gets or sets the Unixtime when the access token was issued last format: int64 GrantIssuedOnISO8601: type: string description: Gets or sets the date and time (UTC) when the access token was issued last, in ISO-8601 format Application: type: string description: Gets or sets the application this grant applies to GranteePrefixedUniversal: type: string description: Gets or sets the prefixed universal of the identity that was used to obtain the grant and/or grants GrantedToPrefixedUniversal: type: string description: Gets or sets the identity that the permission to obtain a grant was issued to. if the permission was assigned to the user directly) description: Holds information about a particular access grant description: Gets or sets a list of _OAuthGrant_ items Core_WebSDK_OAuthWebRequest_revokegrants: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier GranteePrefixedUniversal: type: string description: Grantee Prefixed Universal Identity Core_WebSDK_OAuthWebResponse_revokegrants: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_createrule: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier TrusteePrefixedUniversal: type: string description: Gets or sets the prefixed universal for the trustee MaximumScope: type: string description: Gets or sets the maximum scope for an application Description: type: string description: Gets or sets the description for an application or rule AccessValidity: type: integer description: Gets or sets the duration (in seconds) access tokens should be available for format: int64 nullable: true GrantValidity: type: integer description: Gets or sets the duration (in seconds) grants should be available for format: int64 nullable: true Renewable: type: boolean description: Gets or sets whether grants for an application should be renewable nullable: true Core_WebSDK_OAuthWebResponse_createrule: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Rule: type: object properties: Description: type: string description: Gets or sets the application the description of the rule MaximumScope: type: string description: Gets or sets the maximum scope this rule will grant AccessValidity: type: integer description: Gets or sets the time an access token issued under this rule is valid format: int64 nullable: true GrantValidity: type: integer description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed format: int64 nullable: true Renewable: type: boolean description: Gets or sets if a grant issued under this rule is renewable nullable: true TrusteePrefixedUniversal: type: string description: Gets or sets the identity (user/group) this rule applies to ApplicationId: type: string description: Gets or sets the application that can request access under this rule description: Gets or sets the _OAuthRule_ Core_WebSDK_OAuthWebRequest_getrules: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier TrusteePrefixedUniversal: type: string description: Gets or sets the prefixed universal for the trustee TrusteePrefixedUniversals: type: array items: type: string description: Gets or sets a list of trustee universals to search on MaximumScope: type: string description: Gets or sets the maximum scope for an application Renewable: type: boolean description: Gets or sets whether grants for an application should be renewable nullable: true NoExpire: type: boolean description: Gets or sets filtering rules that have no expiration. **true** to find rules that don't expire. nullable: true ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_getrules: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Rules: type: array items: type: object properties: Description: type: string description: Gets or sets the application the description of the rule MaximumScope: type: string description: Gets or sets the maximum scope this rule will grant AccessValidity: type: integer description: Gets or sets the time an access token issued under this rule is valid format: int64 nullable: true GrantValidity: type: integer description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed format: int64 nullable: true Renewable: type: boolean description: Gets or sets if a grant issued under this rule is renewable nullable: true TrusteePrefixedUniversal: type: string description: Gets or sets the identity (user/group) this rule applies to ApplicationId: type: string description: Gets or sets the application that can request access under this rule description: Data class holding properties describing a rule used to obtain an OAuth grant automatically description: Gets or sets a list of _OAuthRule_ objects Core_WebSDK_OAuthWebRequest_enumeraterules: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Start: type: integer description: Gets or sets the start index for paged APIs format: int32 Count: type: integer description: Gets or sets the maximum number of results to return for paged APIs format: int32 OrderBy: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField' Descending: type: boolean description: Gets or sets ordering direction for query APIs ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_enumeraterules: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Rules: type: array items: type: object properties: Description: type: string description: Gets or sets the application the description of the rule MaximumScope: type: string description: Gets or sets the maximum scope this rule will grant AccessValidity: type: integer description: Gets or sets the time an access token issued under this rule is valid format: int64 nullable: true GrantValidity: type: integer description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed format: int64 nullable: true Renewable: type: boolean description: Gets or sets if a grant issued under this rule is renewable nullable: true TrusteePrefixedUniversal: type: string description: Gets or sets the identity (user/group) this rule applies to ApplicationId: type: string description: Gets or sets the application that can request access under this rule description: Data class holding properties describing a rule used to obtain an OAuth grant automatically description: Gets or sets a list of _OAuthRule_ objects Core_WebSDK_OAuthWebRequest_updaterule: type: object properties: Rule: type: object properties: Description: type: string description: Gets or sets the application the description of the rule MaximumScope: type: string description: Gets or sets the maximum scope this rule will grant AccessValidity: type: integer description: Gets or sets the time an access token issued under this rule is valid format: int64 nullable: true GrantValidity: type: integer description: Gets or sets how long before a grant issued under this rule expires and can no longer be renewed format: int64 nullable: true Renewable: type: boolean description: Gets or sets if a grant issued under this rule is renewable nullable: true TrusteePrefixedUniversal: type: string description: Gets or sets the identity (user/group) this rule applies to ApplicationId: type: string description: Gets or sets the application that can request access under this rule description: Gets or sets the _OAuthRule_ to update Core_WebSDK_OAuthWebResponse_updaterule: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_deleterule: type: object properties: TrusteePrefixedUniversal: type: string description: Gets or sets the prefixed universal for the trustee ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_deleterule: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_deleterules: type: object properties: TrusteePrefixedUniversal: type: string description: Gets or sets the prefixed universal for the trustee ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_deleterules: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_grantcount: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_grantcount: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Count: type: integer description: Gets or sets the requested count format: int32 Core_WebSDK_OAuthWebRequest_usercount: type: object properties: ApplicationId: type: string description: Gets or sets the application identifier Core_WebSDK_OAuthWebResponse_usercount: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Count: type: integer description: Gets or sets the requested count format: int32 Core_WebSDK_OAuthWebRequest_createjwtmapping: type: object properties: Name: type: string description: Gets or sets the name of an application IssuerUri: type: string description: Gets or sets the Issuer URI PurposeField: type: string description: Gets or sets the name of the JWT field indicating the purpose PurposeMatch: type: string description: Gets or sets the value that the _PurposeField_ must have to accept the token IdField: type: string description: Gets or sets the name of the JWT field indicating the identity owning the token IdMatch: type: string description: "Gets or sets the regular expression to apply against the _IdField_ to obtain the identity. \r\nIf\ \ _GranteePrefixedUniversal_ is null, the first matching group of the expression will be used to obtain an identity" GranteePrefixedUniversal: type: string description: Grantee Prefixed Universal Identity JwksUri: type: string description: Optional alternate JWKS endpoint when key discovery location differs from IssuerUri. Core_WebSDK_OAuthWebResponse_createjwtmapping: type: object properties: JwtMapping: type: object properties: IssuerUri: type: string description: The Issuer URI for the mapping JwksUri: type: string description: "Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.\r\ \nWhen supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.\r\ \nNullable and not required for legacy mappings." PurposeField: type: string description: The JWT field to determine the purpose PurposeMatch: type: string description: The value that must match the purpose field to accept the JWT IdField: type: string description: The JWT field to determine the identity IdMatch: type: string description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used GranteePrefixedUniversal: type: string description: The fixed prefixed universal identity to use as grant identity Name: type: string description: Gets or sets the identifier of the application description: Gets or sets the _OAuthJwtMapping_ Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_enumeratejwtmappings: type: object properties: Start: type: integer description: Gets or sets the start index for paged APIs format: int32 Count: type: integer description: Gets or sets the maximum number of results to return for paged APIs format: int32 OrderBy: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthOrderByField' Descending: type: boolean description: Gets or sets ordering direction for query APIs ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_enumeratejwtmappings: type: object properties: JwtMappings: type: array items: type: object properties: IssuerUri: type: string description: The Issuer URI for the mapping JwksUri: type: string description: "Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery\ \ location.\r\nWhen supplied this value can be used by the server to directly locate keys instead of deriving\ \ from IssuerUri.\r\nNullable and not required for legacy mappings." PurposeField: type: string description: The JWT field to determine the purpose PurposeMatch: type: string description: The value that must match the purpose field to accept the JWT IdField: type: string description: The JWT field to determine the identity IdMatch: type: string description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used GranteePrefixedUniversal: type: string description: The fixed prefixed universal identity to use as grant identity Name: type: string description: Gets or sets the identifier of the application description: Holds information about a particular OAuth application description: Gets or sets a collection of _OAuthJwtMapping_ Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_getjwtmappings: type: object properties: Filter: type: string description: Gets or sets a generic filter string IssuerUris: type: array items: type: string description: Gets or sets a list of Issuer URIs ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_getjwtmappings: type: object properties: JwtMappings: type: array items: type: object properties: IssuerUri: type: string description: The Issuer URI for the mapping JwksUri: type: string description: "Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery\ \ location.\r\nWhen supplied this value can be used by the server to directly locate keys instead of deriving\ \ from IssuerUri.\r\nNullable and not required for legacy mappings." PurposeField: type: string description: The JWT field to determine the purpose PurposeMatch: type: string description: The value that must match the purpose field to accept the JWT IdField: type: string description: The JWT field to determine the identity IdMatch: type: string description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used GranteePrefixedUniversal: type: string description: The fixed prefixed universal identity to use as grant identity Name: type: string description: Gets or sets the identifier of the application description: Holds information about a particular OAuth application description: Gets or sets a collection of _OAuthJwtMapping_ Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_getjwtmapping: type: object properties: Name: type: string description: Gets or sets the name of an application ResolveIdentities: type: boolean description: If **true**, prefixed universals will be resolved and included in the response in the _IdentityEntries_ field Core_WebSDK_OAuthWebResponse_getjwtmapping: type: object properties: JwtMapping: type: object properties: IssuerUri: type: string description: The Issuer URI for the mapping JwksUri: type: string description: "Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.\r\ \nWhen supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.\r\ \nNullable and not required for legacy mappings." PurposeField: type: string description: The JWT field to determine the purpose PurposeMatch: type: string description: The value that must match the purpose field to accept the JWT IdField: type: string description: The JWT field to determine the identity IdMatch: type: string description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used GranteePrefixedUniversal: type: string description: The fixed prefixed universal identity to use as grant identity Name: type: string description: Gets or sets the identifier of the application description: Gets or sets the _OAuthJwtMapping_ Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_updatejwtmapping: type: object properties: JwtMapping: type: object properties: IssuerUri: type: string description: The Issuer URI for the mapping JwksUri: type: string description: "Optional alternate JwksUri (JWKS/OpenID) used when the IssuerUri differs from the discovery location.\r\ \nWhen supplied this value can be used by the server to directly locate keys instead of deriving from IssuerUri.\r\ \nNullable and not required for legacy mappings." PurposeField: type: string description: The JWT field to determine the purpose PurposeMatch: type: string description: The value that must match the purpose field to accept the JWT IdField: type: string description: The JWT field to determine the identity IdMatch: type: string description: The regular expression to apply to the identity field to determine the grant identity (or **null** if _GranteePrefixedUniversal_ is used GranteePrefixedUniversal: type: string description: The fixed prefixed universal identity to use as grant identity Name: type: string description: Gets or sets the identifier of the application description: Gets or sets the _OAuthJwtMapping_ Core_WebSDK_OAuthWebResponse_updatejwtmapping: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_OAuthWebRequest_deletejwtmapping: type: object properties: Name: type: string description: Gets or sets the name of an application Core_WebSDK_OAuthWebResponse_deletejwtmapping: type: object properties: Success: type: boolean description: "All requests that are have a valid grant and scope will be accepted with a 200 (OK) HTTP response\ \ code. The\r\nSuccess variable in the response body will indicate if the **API** call itself was successful." Result: $ref: '#/components/schemas/Web_SDK_Authentication_OAuthResult' Error: type: string description: Gets or sets the error Core_WebSDK_StatsWebRequest_createcounter: required: - StatsType - Name type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Name: type: string description: The name of the counter Description: type: string description: The description of the counter MetadataAName: type: string description: The name for Tag A MetadataBName: type: string description: The name for Tag B MetadataCName: type: string description: The name for Tag C ValueDescription: type: string description: The description for the counter value Sensitive: type: boolean description: '**true** or **false**; Indicates if the counter can only be viewed by authorized users' Core_WebSDK_StatsWebResponse_createcounter: type: object properties: Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_deletecounter: required: - StatsType type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Core_WebSDK_StatsWebResponse_deletecounter: type: object properties: Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_renamecounter: required: - StatsType - Name type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Name: type: string description: The name of the counter Core_WebSDK_StatsWebResponse_renamecounter: type: object properties: Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_updatecounter: required: - StatsType type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Description: type: string description: The description of the counter MetadataAName: type: string description: The name for Tag A MetadataBName: type: string description: The name for Tag B MetadataCName: type: string description: The name for Tag C ValueDescription: type: string description: The description for the counter value Sensitive: type: boolean description: '**true** or **false**; Indicates if the counter can only be viewed by authorized users' Core_WebSDK_StatsWebResponse_updatecounter: type: object properties: Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_getcounter: required: - StatsType type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Core_WebSDK_StatsWebResponse_getcounter: type: object properties: Counter: type: object properties: Error: type: string description: Gets the last error for this _StatsCounter_ instance StatsType: type: integer description: Gets the identifier of this statistics counter format: int32 Name: type: string description: Gets the name of this counter Description: type: string description: Gets the description of this counter Disabled: type: boolean description: Gets a value indication the current counter is not recording counts ValueDescription: type: string description: Gets the description of the value if the counter utilizes it AName: type: string description: Gets the descriptive name of the first metadata field BName: type: string description: Gets the descriptive name of the second metadata field CName: type: string description: Gets the descriptive name of the third metadata field Sensitive: type: boolean description: Gets a value indicating this counter contains sensitive information IgnoreCount: type: boolean description: Gets a value indicating this counter only conveys useful information in the value (e.g. if the counter is triggered on an interval) description: The counter Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_getcounters: type: object properties: StatsCode: type: integer description: The family of the counter format: int32 Core_WebSDK_StatsWebResponse_getcounters: type: object properties: Counters: type: array items: type: object properties: Error: type: string description: Gets the last error for this _StatsCounter_ instance StatsType: type: integer description: Gets the identifier of this statistics counter format: int32 Name: type: string description: Gets the name of this counter Description: type: string description: Gets the description of this counter Disabled: type: boolean description: Gets a value indication the current counter is not recording counts ValueDescription: type: string description: Gets the description of the value if the counter utilizes it AName: type: string description: Gets the descriptive name of the first metadata field BName: type: string description: Gets the descriptive name of the second metadata field CName: type: string description: Gets the descriptive name of the third metadata field Sensitive: type: boolean description: Gets a value indicating this counter contains sensitive information IgnoreCount: type: boolean description: Gets a value indicating this counter only conveys useful information in the value (e.g. if the counter is triggered on an interval) description: Counts occurrences of statistics data description: The list of counters Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebResponse_countercontainers: type: object properties: CounterContainers: type: array items: type: object properties: Name: type: string description: Stats counter name StatsCode: type: integer description: Stats counter family format: int32 description: Represents containers description: The list of counter components and their descriptions Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_query: required: - StatsType type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Tier: $ref: '#/components/schemas/Core_StatsTier' MaxPoints: type: integer description: The maximum number of data points format: int32 GroupByA: type: boolean description: '**true** or **false**' GroupByB: type: boolean description: '**true** or **false**' GroupByC: type: boolean description: '**true** or **false**' FilterA: type: string description: The filter value FilterB: type: string description: The filter value FilterC: type: string description: The filter value Core_WebSDK_StatsWebResponse_query: type: object properties: Results: type: object additionalProperties: type: array items: type: object properties: TimeFrame: type: string description: The date value. Type: type: integer description: The type of statistic format: int32 TagA: type: string description: The optional first tag for this set TagB: type: string description: The optional second tag for this set TagC: type: string description: The optonal third tag for this set Count: type: integer description: The count of times this counter occurred in the time frame format: int64 SumValue: type: integer description: The aggregated sum of the value associated with the point format: int64 description: A single statistics counter description: Statistics points belonging to the group description: 'Dictionary of statistics values. The key for each value list is in the form of AName|BName|CName **Key**: Tag identifier for the values' Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_StatsWebRequest_querytags: required: - StatsType type: object properties: StatsType: type: integer description: The ID of the counter format: int32 Filter: type: string description: The filter value TagNumber: type: integer description: If negative then all tag values will be returned format: int32 Core_WebSDK_StatsWebResponse_querytags: type: object properties: TagAValues: type: array items: type: string description: Contains unique tag values for Tag A TagBValues: type: array items: type: string description: Contains unique tag values for Tag B TagCValues: type: array items: type: string description: Contains unique tag values for Tag C Success: type: boolean description: '**true** or **false**' Error: type: string description: The error Core_WebSDK_EnginesResponse: type: object properties: Engines: type: array items: type: object properties: EngineName: type: string description: Engine Name EngineGuid: type: string description: Engine Guid EngineDN: type: string description: Engine DN _links: type: object properties: self: type: object properties: href: type: string description: Link to resource details description: Link to resource details description: Resource link description: Represents details about an engine description: List of engines description: All engines Core_WebSDK_FolderRestrictionsResponse: type: object properties: Engines: type: array items: type: object properties: EngineName: type: string description: Engine Name EngineGuid: type: string description: Engine Guid EngineDN: type: string description: Engine DN _links: type: object properties: self: type: object properties: href: type: string description: Link to resource details description: Link to resource details description: Resource link description: Represents details about an engine description: List of engines that can be used for processing a folder description: Folder Restrictions Response Core_WebSDK_EngineRestrictionsResponse: type: object properties: Folders: type: array items: type: object properties: FolderName: type: string description: Folder Name FolderGuid: type: string description: Folder Guid FolderDN: type: string description: Folder DN _links: type: object properties: self: type: object properties: href: type: string description: Link to resource details description: Link to resource details description: Resource link description: Represents details about a folder description: List of engine restrictions description: Engine Restrictions Response Core_WebSDK_EngineRestrictionsRequest_engine__engineGuid_: required: - FolderGuids type: object properties: FolderGuids: type: array items: type: string description: List of folders that will be processed by an engine Core_WebSDK_AddOperationResponse: type: object properties: AddedCount: type: integer description: Count of added restrictions format: int32 Errors: type: array items: type: string description: List of errors that occurred while processing the request description: Represents request to add a new part Core_WebSDK_FolderRestrictionsRequest: type: object properties: EngineGuids: type: array items: type: string description: List of engines that can be used for processing a folder description: Represents request to add a new partition management restrictions Core_WebSDK_PermissionsWebRequest: type: object properties: ObjectDN: type: string description: The object dn. ObjectGuid: type: string description: The object unique identifier. Principal: type: string description: The prefixed universal string Permissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. IsAuditor: type: boolean description: Gets or sets a value indicating whether the principal is an auditor. description: The explicit permissions. description: '' Core_WebSDK_PermissionsWebRequest_getprincipals: type: object properties: ObjectDN: type: string description: The object dn. ObjectGuid: type: string description: The object unique identifier. Core_WebSDK_PermissionsWebResponse_getprincipals: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Principals: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The principals. Core_WebSDK_PermissionsWebRequest_getpermissions: type: object properties: Principal: type: string description: The prefixed universal string ObjectDN: type: string description: The object dn. ObjectGuid: type: string description: The object unique identifier. Core_WebSDK_PermissionsWebResponse_getpermissions: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Permissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. IsAuditor: type: boolean description: Gets or sets a value indicating whether the principal is an auditor. description: The explicit permissions. Core_WebSDK_PermissionsWebRequest_geteffectivepermissions: type: object properties: Principal: type: string description: The prefixed universal string ObjectDN: type: string description: The object dn. ObjectGuid: type: string description: The object unique identifier. Core_WebSDK_PermissionsWebResponse_geteffectivepermissions: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Permissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. IsAuditor: type: boolean description: Gets or sets a value indicating whether the principal is an auditor. description: The explicit permissions. Core_WebSDK_PermissionsWebResponse_grantpermissions: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Core_WebSDK_PermissionsWebRequest_revokepermissions: type: object properties: Principal: type: string description: The prefixed universal string ObjectDN: type: string description: The object dn. ObjectGuid: type: string description: The object unique identifier. Core_WebSDK_PermissionsWebResponse_revokepermissions: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Core_WebSDK_PermissionsWebResponse_replacepermissions: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Core_WebSDK_PermissionsWebResponse_refresh: type: object properties: Result: $ref: '#/components/schemas/Permissions_PermissionsResult' Core_WebSDK_AssignedPermissionsResponse: type: object properties: Error: type: string description: The error. ExplicitPermissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. description: The explicit permissions. ImplicitPermissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. description: The implicit permissions. description: '' Core_WebSDK_EffectivePermissionsResponse: type: object properties: Error: type: string description: The error. EffectivePermissions: type: object properties: IsViewAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to view objects. IsReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read objects. IsWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write objects. IsPolicyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write policy to objects. IsCreateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to create objects. IsDeleteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to delete objects. IsRenameAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to rename objects. IsManagePermissionsAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to manage rights to objects. IsAssociateAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to associate objects. IsRevokeAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to revoke objects. IsPrivateKeyReadAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to read private keys. IsPrivateKeyWriteAllowed: type: boolean description: Gets or sets a value indicating whether the principal is allowed to write private keys. description: The effective permissions. description: Data class representing REST permission response Core_WebSDK_ConfigWebRequest_enumerate: required: - Recursive - Pattern - ObjectDN type: object properties: Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_enumerate: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_enumerateall: required: - Pattern - ObjectDN type: object properties: Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_enumerateall: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_enumeratepolicies: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebResponse_enumeratepolicies: type: object properties: Policies: type: array items: type: object properties: GUID: type: string description: "The _GUID_ associated \r\nwith this _ConfigPolicy_ object." TypeName: type: string description: A schema class name. AttributeName: type: string description: A schema attribute name. ValueList: type: array items: type: string description: A list of values Property: $ref: '#/components/schemas/Core_ConfigPolicy_Properties' description: The CyberArk storage system for effective attribute values. description: The policies. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_enumerateobjectsderivedfrom: required: - DerivedFrom type: object properties: DerivedFrom: type: string description: The derived from. Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebResponse_enumerateobjectsderivedfrom: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_create: required: - ObjectDN - Class type: object properties: ObjectDN: type: string description: The object dn. Class: type: string description: The class. NameAttributeList: type: object description: The name attribute list. Core_WebSDK_ConfigWebResponse_create: type: object properties: Object: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of a\ \ container, if a subordinate object is added or deleted." format: int64 description: A `ConfigObject` item, describing an object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_delete: type: object properties: ObjectID: type: integer description: The ID of the object to delete. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object to delete. Only honored if ObjectID is not provided. Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." Core_WebSDK_ConfigWebResponse_delete: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_defaultdn: type: object properties: DefaultDN: type: string description: The default DN. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_find: type: object properties: ObjectDN: type: string description: The object dn. Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." ObjectPattern: type: string description: The pattern. Class: type: string description: The class. IncludeDerivedClasses: type: boolean description: '**true** if derived classes will be included; otherwise, **false**.' AttributeName: type: string description: The attribute name. AttributeNames: type: array items: type: string description: The attribute name list. Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebResponse_find: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readall: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebResponse_readall: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' NameValues: type: array items: type: object properties: Name: type: string description: The name. Values: type: array items: type: string description: The values. description: Class to pass when creating a new config object description: The name values. Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_findcontainers: type: object properties: ObjectID: type: integer description: The ID of the object whose children to search. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose children to search. Only honored if ObjectID is not provided. Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." Core_WebSDK_ConfigWebResponse_findcontainers: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_findobjectsofclass: type: object properties: ObjectDN: type: string description: The object dn. ObjectID: type: integer description: Gets or sets the object id. format: int64 Class: type: string description: The class. Classes: type: array items: type: string description: The classes. Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigWebResponse_findobjectsofclass: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: A list of `ConfigObject` items, each describing an individual object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_findpolicy: required: - Class - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object to find policy for. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object to find policy for. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_findpolicy: type: object properties: PolicyDN: type: string description: The DN of the object the policy values are inherited from Locked: type: boolean description: '**true** if locked; otherwise, **false**.' nullable: true Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_gethighestrevision: type: object properties: ObjectID: type: integer description: The ID of the object whose revision to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose revision to read. Only honored if ObjectID is not provided. Classes: type: array items: type: string description: The classes. Core_WebSDK_ConfigWebResponse_gethighestrevision: type: object properties: Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_getrevision: type: object properties: ObjectID: type: integer description: The ID of the object whose revision to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose revision to read. Only honored if ObjectID is not provided. Core_WebSDK_ConfigWebResponse_getrevision: type: object properties: Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_getobjecttrustees: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_getobjecttrustees: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_guidtodn: required: - ObjectGUID type: object properties: ObjectGUID: type: string description: The object GUID. Core_WebSDK_ConfigWebResponse_guidtodn: type: object properties: ClassName: type: string description: A schema class name. ObjectDN: type: string description: An oject DN. Revision: type: integer description: The revision. format: int64 HierarchicalGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself.. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_isvalid: type: object properties: ObjectDN: type: string description: The object dn. ObjectID: type: integer description: Gets or sets the object id. format: int64 ObjectGUID: type: string description: The object GUID. Core_WebSDK_ConfigWebResponse_isvalid: type: object properties: Object: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of a\ \ container, if a subordinate object is added or deleted." format: int64 description: A `ConfigObject` item, describing an object. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_mutateobject: required: - ObjectDN - Class type: object properties: ObjectDN: type: string description: The object dn. Class: type: string description: The class. Core_WebSDK_ConfigWebResponse_mutateobject: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_containableclasses: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_containableclasses: type: object properties: ClassNames: type: array items: type: string description: A list of schema class names. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_dntoguid: required: - ObjectDN type: object properties: ObjectDN: type: string description: The object dn. Core_WebSDK_ConfigWebResponse_dntoguid: type: object properties: ClassName: type: string description: A schema class name. GUID: type: string description: An object GUID. HierarchicalGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself.. Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_idinfo: required: - ObjectID type: object properties: ObjectID: type: integer description: Gets or sets the object id. format: int64 Core_WebSDK_ConfigWebResponse_idinfo: type: object properties: ClassName: type: string description: A schema class name. GUID: type: string description: An object GUID. ObjectDN: type: string description: An oject DN. HierarchicalGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself.. Revision: type: integer description: The revision. format: int64 Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_renameobject: required: - ObjectDN - NewObjectDN type: object properties: ObjectDN: type: string description: The object dn. NewObjectDN: type: string description: The new object DN. Core_WebSDK_ConfigWebResponse_renameobject: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_clearattribute: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to clear. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to clear. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_clearattribute: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_clearpolicyattribute: required: - Class - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to clear. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to clear. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_clearpolicyattribute: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_read: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_read: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_countobjects: type: object properties: ObjectID: type: integer description: The ID of the object whose children to count. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose children to count. Only honored if ObjectID is not provided. Type: type: string description: The object type. Recursive: type: boolean description: "Boolean indicating if children of returned objects should be returned as well\r\n* **true**: Return\ \ children and children of children.\r\n* **false**: Default. Only return objects in the specified container." Pattern: type: string description: "An expression for filtering matches. \r\n\r\n\r\n\r\nWildcards are asterisk (*) and question mark\ \ (?), to escape a wildcard use two backslashes (\\\\)" Core_WebSDK_ConfigCountWebResponse: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Count: type: integer description: The count. format: int64 description: Response for a successful config request Core_WebSDK_ConfigWebRequest_readdn: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_readdn: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readdnreferences: required: - AttributeName - ReferenceAttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. ReferenceAttributeName: type: string description: The name of the reference attribute. Core_WebSDK_ConfigWebResponse_readdnreferences: type: object properties: Values: type: array items: type: string description: A list of values. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readeffectivepolicy: required: - AttributeName type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Core_WebSDK_ConfigWebResponse_readeffectivepolicy: type: object properties: Values: type: array items: type: string description: A list of values. Overridden: type: boolean description: '**true** if overriden; otherwise, **false**.' nullable: true Locked: type: boolean description: '**true** if locked; otherwise, **false**.' nullable: true PolicyDN: type: string description: The DN of the object the policy values are inherited from Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_readpolicy: required: - AttributeName - Class type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to read. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to read. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Class: type: string description: The class. Core_WebSDK_ConfigWebResponse_readpolicy: type: object properties: Values: type: array items: type: string description: A list of values. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' nullable: true Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_addvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_addvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_adddnvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_adddnvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_addpolicyvalue: required: - Class - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to add. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to add. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' Core_WebSDK_ConfigWebResponse_addpolicyvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_removevalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_removevalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_removednvalue: required: - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_removednvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_removepolicyvalue: required: - Class - AttributeName - Value type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to remove. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to remove. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Value: type: string description: The value. Core_WebSDK_ConfigWebResponse_removepolicyvalue: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_write: type: object properties: ObjectID: type: integer description: The ID of the object whose attributes to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attributes to write. Only honored if ObjectID is not provided. AttributeData: type: object description: Gets or sets many attribute values AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Core_WebSDK_ConfigWebResponse_write: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_writedn: required: - AttributeName - Values type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to write. Only honored if ObjectID is not provided. AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Core_WebSDK_ConfigWebResponse_writedn: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebRequest_writepolicy: required: - Class - AttributeName - Values type: object properties: ObjectID: type: integer description: The ID of the object whose attribute to write. Takes precedence over ObjectDN. format: int64 ObjectDN: type: string description: The DN of the object whose attribute to write. Only honored if ObjectID is not provided. Class: type: string description: The class. AttributeName: type: string description: The attribute name. Values: type: array items: type: string description: The values. Locked: type: boolean description: '**true** if locked; otherwise, **false**.' Core_WebSDK_ConfigWebResponse_writepolicy: type: object properties: Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebSchemaRequest_classes: type: object properties: DerivedFrom: type: string description: The derived from class name. Core_WebSDK_ConfigWebResponse_classes: type: object properties: ClassDefinitions: type: array items: type: object properties: Id: type: integer description: The storage ID. format: int32 Property: $ref: '#/components/schemas/Core_SchemaClass_Properties' Name: type: string description: "The name for this _SchemaClass_\r\nobject." SuperClassNames: type: array items: type: string description: The super class names. ContainmentNames: type: array items: type: string description: The containment names. ContainmentSubNames: type: array items: type: string description: The containment sub names. OptionalNames: type: array items: type: string description: The optional names. OptionalNamesEx: type: array items: type: string description: The optional attribute names. SuperClassesExNames: type: array items: type: string description: The super class names. description: Class representing a schema class. description: A list of schema class definitions. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebSchemaRequest_class: type: object properties: Class: type: string description: The class. Core_WebSDK_ConfigWebResponse_class: type: object properties: ClassDefinition: type: object properties: Id: type: integer description: The storage ID. format: int32 Property: $ref: '#/components/schemas/Core_SchemaClass_Properties' Name: type: string description: "The name for this _SchemaClass_\r\nobject." SuperClassNames: type: array items: type: string description: The super class names. ContainmentNames: type: array items: type: string description: The containment names. ContainmentSubNames: type: array items: type: string description: The containment sub names. OptionalNames: type: array items: type: string description: The optional names. OptionalNamesEx: type: array items: type: string description: The optional attribute names. SuperClassesExNames: type: array items: type: string description: The super class names. description: A schema class definition. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebResponse_attributes: type: object properties: AttributeDefinitions: type: array items: type: object properties: Syntax: $ref: '#/components/schemas/Core_SchemaAttribute_Syntaxes' Property: $ref: '#/components/schemas/Core_SchemaAttribute_Properties' Name: type: string description: The attribute name Id: type: integer description: Gets the attribute ID format: int64 description: The CyberArk storage system for schema attributes. description: A list of schema attribute definitions. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_ConfigWebSchemaRequest_attribute: type: object properties: Attribute: type: string description: The attribute. Core_WebSDK_ConfigWebResponse_attribute: type: object properties: AttributeDefinition: type: object properties: Syntax: $ref: '#/components/schemas/Core_SchemaAttribute_Syntaxes' Property: $ref: '#/components/schemas/Core_SchemaAttribute_Properties' Name: type: string description: The attribute name Id: type: integer description: Gets the attribute ID format: int64 description: A schema attribute definition. Result: $ref: '#/components/schemas/Core_ConfigResult' Error: type: string description: An error description, or **null**. Core_WebSDK_X509CertificateStoreWebRequest_add: required: - OwnerDN type: object properties: ProtectionKey: type: string description: The key used to protect the certificate. OwnerDN: type: string description: The distinguished name of the owner of the certificate. Core_WebSDK_X509CertificateStoreWebResponse: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. ProtectionKey: type: string description: The key used to protect the certificate. CertificateString: type: string description: The base64-encoded string representation of the certificate. CertificateCollectionStrings: type: array items: type: string description: A list of base64-encoded string representations of the certificates in the collection. OwnerDN: type: string description: The distinguished name of the owner of the certificate. LeafExisted: type: boolean description: '**true** if the leaf certificate existed; otherwise, **false**.' nullable: true Result: $ref: '#/components/schemas/Core_SecretStoreResult' Name: type: string description: The name associated with the certificate. Value: type: string description: The value associated with the certificate. TypedNameValues: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: Class representing a store association item description: A list of typed name-value pairs for serialization. description: Represents a response from operations performed on the X.509 certificate store. Core_WebSDK_X509CertificateStoreWebResponse_add: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 LeafExisted: type: boolean description: '**true** if the leaf certificate existed; otherwise, **false**.' nullable: true Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebRequest_lookup: type: object properties: OwnerDN: type: string description: The distinguished name of the owner of the certificate. Name: type: string description: The name associated with the certificate. Value: type: string description: The value associated with the certificate. Core_WebSDK_X509CertificateStoreWebResponse_lookup: type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebRequest_lookupexpiring: required: - OwnerDN - DaysToExpiration type: object properties: OwnerDN: type: string description: The distinguished name of the owner of the certificate. DaysToExpiration: type: integer description: The number of days until the certificate expires. format: int32 nullable: true Core_WebSDK_X509CertificateStoreWebResponse_lookupexpiring: type: object properties: VaultIds: type: array items: type: integer format: int64 description: A list of unique identifiers of the certificates in the vault. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebRequest_remove: required: - OwnerDN type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 nullable: true OwnerDN: type: string description: The distinguished name of the owner of the certificate. Core_WebSDK_X509CertificateStoreWebResponse_remove: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_X509CertificateStoreWebRequest_retrieve: required: - VaultId type: object properties: VaultId: type: integer description: The unique identifier of the certificate in the vault. format: int64 nullable: true Core_WebSDK_X509CertificateStoreWebResponse_retrieve: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_CredentialsWebRequest_create: required: - Description - Contact - FriendlyName - Classname - Values - CredentialPath type: object properties: Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. Core_WebSDK_CredentialsWebResponse_create: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_delete: required: - CredentialPath type: object properties: CredentialPath: type: string description: DN of the credential to delete Core_WebSDK_CredentialsWebResponse_delete: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_enumerate: required: - CredentialPath type: object properties: CredentialPath: type: string description: Container whose credential objects to enumerate Pattern: type: string description: Pattern to filter by Recursive: type: boolean description: If *true*, subcontainers are searched as well Core_WebSDK_CredentialsWebResponse_enumerate: type: object properties: CredentialInfos: type: array items: type: object properties: ClassName: type: string description: Gets/sets the config class name FullName: type: string description: Gets/sets the full path and name of the credential description: Class describing a credential item description: A list of credential objects matching the criteria Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_rename: required: - CredentialPath - NewCredentialPath type: object properties: CredentialPath: type: string description: The DN of the credential to rename NewCredentialPath: type: string description: The new DN of the credential. Must be the same parent DN as *CredentialPath*, move is not allowed Core_WebSDK_CredentialsWebResponse_rename: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_retrieve: required: - CredentialPath type: object properties: CredentialPath: type: string description: The DN of the credential to retrieve Core_WebSDK_CredentialsWebResponse_retrieve: type: object properties: Shared: type: boolean description: '**true** if shown when browsing for credentials; otherwise, **false**.' Contact: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The contact. Expiration: type: string description: Expiration date of the credential (in MS Dateime JSON format - milliseconds since 1/1/1970) EncryptionKey: type: string description: The encryption key. Description: type: string description: The description. FriendlyName: type: string description: The friendly name. Classname: type: string description: The classname. Values: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: '' description: The description. Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CredentialsWebRequest_update: required: - Description - Contact - FriendlyName - Classname - Values - CredentialPath type: object properties: Description: type: string description: A brief description of the credential. EncryptionKey: type: string description: The encryption key used to secure the credential. Expiration: type: string description: The date and time when the credential expires. Contact: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: A list of identity entries representing the contacts responsible for the credential. Shared: type: boolean description: '**true** if the credential is shared; otherwise, **false**.' FriendlyName: type: string description: The user-friendly name of the credential. Classname: type: string description: The class name that defines the type of the credential. Values: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: '' description: A list of name-value pairs representing the credential's attributes. CredentialPath: type: string description: The distinguished name (DN) path of the credential. Core_WebSDK_CredentialsWebResponse_update: type: object properties: Result: $ref: '#/components/schemas/Core_CredentialResult' Core_WebSDK_CryptoWebResponse_availablekeys: type: object properties: Keynames: type: array items: type: string description: The keynames. Core_WebSDK_CryptoWebResponse_defaultkey: type: object properties: DefaultKey: type: string description: The default key. Core_WebSDK_IdentityWebRequest_browse: type: object properties: Container: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The container Filter: type: string description: "The individual identity, group identity, or distribution group name to search for in the provider.\ \ \r\nFor AD or LDAP providers, use both the Filter and Limit parameters. For AD, Identity/Browse searches \r\n\ the Ambiguous Name Resolution (ANR) attributes in the AD provider. The attributes, which are included \r\nin ANR\ \ lookups, can be controlled by the AD administrator or from the default set that is \r\navailable from Microsoft." Limit: type: integer description: The maximum number of items to return format: int32 IdentityType: $ref: '#/components/schemas/Core_IdentityType' Core_WebSDK_IdentityWebResponse_browse: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Core_WebSDK_IdentityWebRequest_getassociatedentries: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Core_WebSDK_IdentityWebResponse_getassociatedentries: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Core_WebSDK_IdentityWebRequest_getmembers: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Core_WebSDK_IdentityWebResponse_getmembers: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Core_WebSDK_IdentityWebRequest_getmemberships: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Core_WebSDK_IdentityWebResponse_getmemberships: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Core_WebSDK_IdentityWebRequest_readattribute: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Core_WebSDK_IdentityWebResponse_readattribute: type: object properties: Attributes: type: array items: type: string description: The attributes. Core_WebSDK_IdentityWebRequest_validate: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Core_WebSDK_IdentityWebResponse_validate: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The ID. Core_WebSDK_IdentityWebResponse_self: type: object properties: Identities: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The identities. Core_WebSDK_IdentityWebRequest_SetPassword: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Password: type: string description: The new identity password. OldPassword: type: string description: The old identity password. Core_WebSDK_IdentityWebResponse_SetPassword: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The ID. Core_WebSDK_IdentityWebRequest_addgroup: type: object properties: Name: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity name. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The members OldPassword: type: string description: The old identity password. Core_WebSDK_IdentityWebResponse_addgroup: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The ID. InvalidMembers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The invalid members. Core_WebSDK_IdentityWebRequest_renamegroup: type: object properties: Group: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of a group NewGroupName: type: string description: The new group name Core_WebSDK_IdentityWebResponse_renamegroup: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The ID. Core_WebSDK_IdentityWebResponse_group__prefix___principal_: type: object properties: Message: type: string description: The error. Core_WebSDK_IdentityWebRequest_addgroupmembers: type: object properties: Group: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of a group Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The members Core_WebSDK_IdentityWebResponse_addgroupmembers: type: object properties: InvalidMembers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The invalid members. Message: type: string description: The error. Core_WebSDK_IdentityWebRequest_removegroupmembers: type: object properties: Group: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of a group Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The members ShowMembers: type: boolean description: '**true** if to be returned; otherwise, **false**.' Core_WebSDK_IdentityWebResponse_removegroupmembers: type: object properties: InvalidMembers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The invalid members. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The members. Message: type: string description: The error. Core_WebSDK_MetadataWebRequest_set: required: - DN - GuidData - KeepExisting type: object properties: DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response. GuidData: type: array items: type: object properties: ItemGuid: type: string description: The GUID that identifies the Custom Field. To get the Custom Field GUID, use POST Metadata/GetItems. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, _{3d6b61d-1c71-4603-883f-25b8c2ceecdd}_. List: type: array items: type: string description: An array of one or more Custom Field value changes. The value must match a Metadata Field Type. For example, to set a date, use the MM/DD/YYYY format. description: Support class to allow serialization of values for a metadata object description: An array of ItemGuid-List pairs that apply to the DN. Each pair uniquely identifies a Custom Field and the new value(s). If _GuidData_ is empty and _KeepExisting_ is **false** or not specified, every Custom Field for the DN resets to null. KeepExisting: type: boolean description: "The flag to control Custom Field updates:\r\n* **true**: Update only the Custom Fields based on _GuidData_\ \ values. All other Custom Fields for the DN remain unchanged.\r\n* **false**: Default. Clear all Custom Fields\ \ for the DN, and then set only the Custom Field values based on _GuidData_. If _GuidData_ is empty, all fields\ \ reset to **null**.\r\n\r\n**WARNING**: To retain existing Custom Field values, be sure to set _KeepExisting_\ \ to true. Otherwise, the values for any Custom Fields of the DN, which are absent in the _GuidData_, will be\ \ cleared._" Core_WebSDK_MetadataWebResponse_set: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_setpolicy: required: - DN - SchemaClass - Locked - GuidData type: object properties: DN: type: string description: The DN of a policy folder that has values for at least one Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response. SchemaClass: type: string description: The Device or X509 Certificate class. (_Pre-24.1 this parameter was named ConfigClass_) Locked: type: boolean description: Boolean indicating whether the value is to be locked by policy. If not specified, the value will not be locked by policy. GuidData: type: array items: type: object properties: ItemGuid: type: string description: The GUID that identifies the Custom Field. To get the Custom Field GUID, use POST Metadata/GetItems. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, _{3d6b61d-1c71-4603-883f-25b8c2ceecdd}_. List: type: array items: type: string description: An array of one or more Custom Field value changes. The value must match a Metadata Field Type. For example, to set a date, use the MM/DD/YYYY format. description: Support class to allow serialization of values for a metadata object description: An array of ItemGuid-List pairs that apply to the DN. Each pair uniquely identifies a Custom Field and the new value(s). If _GuidData_ is empty and _KeepExisting_ is **false** or not specified, every Custom Field for the DN resets to null. Core_WebSDK_MetadataWebResponse_setpolicy: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Locked: type: boolean description: "The Policy status:\r\n* **true**: The Policy value, which applies to the Custom Field, is locked.\r\ \n* **false**: The Policy value for the Custom Field can be overridden at the object level." Core_WebSDK_MetadataWebRequest_get: required: - DN type: object properties: DN: type: string description: The DN of a certificate or device. All: type: boolean description: Boolean indicating that all Custom Fields that apply to this object should be returned, even if no values exist for them. Core_WebSDK_MetadataWebResponse_get: type: object properties: GuidData: type: object additionalProperties: type: array items: type: string description: Values stored for the Custom Field on the object description: 'A dictionary of every Custom Field value for an object. **Key**: GUID of the Custom Field definition' Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_readeffectivevalues: required: - ItemGuid - DN type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. To get the GUIDs for a DN, use `POST Medata/GetItemGuids`. DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. Core_WebSDK_MetadataWebResponse_readeffectivevalues: type: object properties: Values: type: array items: type: string description: The values stored for the Custom Field Overridden: type: boolean description: "* **true**: The Policy value was overridden by the value set on the object itself.\r\n* **false**:\ \ The suggested Policy value was used." Locked: type: boolean description: "The Policy status:\r\n* **true**: The Policy value, which applies to the Custom Field, is locked.\r\ \n* **false**: The Policy value for the Custom Field can be overridden at the object level." PolicyDn: type: string description: DN of the policy where values are set Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_readpolicy: required: - ItemGuid - DN - Type type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. To get the GUIDs for a DN, use `POST Medata/GetItemGuids`. DN: type: string description: The DN of a Certificate or Device object that contains a Custom Field. Type: type: string description: The class type to read policy for Core_WebSDK_MetadataWebResponse_readpolicy: type: object properties: Values: type: array items: type: string description: The values stored for the Custom Field Locked: type: boolean description: "The Policy status:\r\n* **true**: The Policy value, which applies to the Custom Field, is locked.\r\ \n* **false**: The Policy value for the Custom Field can be overridden at the object level." Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_getitems: required: - DN type: object properties: DN: type: string description: The DN of a Certificate or Device object to look up. Core_WebSDK_MetadataWebResponse_getitems: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields applicable the the specified object. Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_getitemguids: required: - DN type: object properties: DN: type: string description: The DN of a Certificate or Device object to look up. Core_WebSDK_MetadataWebResponse_getitemguids: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields GUIDs applicable the the specified object. Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_getpolicyitems: required: - DN type: object properties: DN: type: string description: A container DN. Core_WebSDK_MetadataWebResponse_getpolicyitems: type: object properties: PolicyItems: type: object additionalProperties: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields applicable to children of the object. description: "_This property is a dictionary._ \nkey1: value1 \nkey2: value2 \n..." Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_getitemsforclass: required: - SchemaClass type: object properties: SchemaClass: type: string description: "An object class (_Pre-24.1 this parameter was named `ConfigClass`_)\r\n\r\nCommon object classes\ \ are: \r\n* `Code Signing Environment Base`: Show the Custom Fields for Code Signing Project Environments\r\n\ * `Code Signing Project`: Show the Custom Fields for Code Signing Projects \r\n* `Device`: Show the Custom Fields\ \ for Devices\r\n* `X509 Certificate`: Show the Custom Fields for Certificates" Core_WebSDK_MetadataWebResponse_getitemsforclass: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: An array of Custom Fields available to be set on the specified object class Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_find: type: object properties: ItemGuid: type: string description: The GUID of a Custom Field. If provided, only values of this Custom Field are searched Value: type: string description: The value a stored Custom Field value must match. Core_WebSDK_MetadataWebResponse_find: type: object properties: Objects: type: array items: type: object properties: TypeName: type: string description: The schema class of the object DN: type: string description: The DN of the object. GUID: type: string description: The GUID of the object. Name: type: string description: The name (CN) of the object. Disabled: type: boolean description: '**true** if the object is excluded from processing; **false** otherwise.' InError: type: boolean description: '**true** if an error processing a request for the object has occurent; **false** otherwise.' Id: type: integer description: The unique ID of this object. format: int64 nullable: true Parent: type: string description: The DN of the parent object. AbsoluteGUID: type: string description: A concatenated string of GUIDs of the object's hierarchy, from the root to the object itself. Revision: type: integer description: "The revision of this object.\r\n\r\nRevisions are updated with each change, and, in case of\ \ a container, if a subordinate object is added or deleted." format: int64 description: The CyberArk storage system for object referencing. description: The list of objects that have a matching Custom Field value Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_defineitem: required: - Item type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: A metadata item that represents the Custom Field to be created. A Custom Field requires, at a minimum, the `Label`, `Name`, `Classes` and `Type` properties. Core_WebSDK_MetadataWebResponse_defineitem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The newly created metadata item (Custom Field) definition. DN: type: string description: The DN of the newly created Custom Field definition Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_undefineitem: required: - ItemGuid type: object properties: ItemGuid: type: string description: The GUID of the Custom Field to delete. RemoveData: type: boolean description: "Boolean indicating if existing values should be deleted when the Custom Field is deleted:\r\n* **true**:\ \ Delete existing values stored for the Custom Field before deleting the Custom Field itself.\r\n* **false**:\ \ Default. Do not delete any stored values. If values exist, the delete of the Custom Field will fail." Core_WebSDK_MetadataWebResponse_undefineitem: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_finditem: required: - Name type: object properties: Name: type: string description: The label or name of the Custom Field to find. Core_WebSDK_MetadataWebResponse_finditem: type: object properties: ItemGuid: type: string description: The GUID of the matching Custom Field, if a match was found Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_loaditem: required: - DN type: object properties: DN: type: string description: The DN of the Custom Field to return. Core_WebSDK_MetadataWebResponse_loaditem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The metadata item (Custom Field) definition Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_loaditemguid: required: - DN type: object properties: DN: type: string description: The DN of the Custom Field to return. Core_WebSDK_MetadataWebResponse_loaditemguid: type: object properties: ItemGuid: type: string description: The GUID of the Custom Field Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebRequest_updateitem: type: object properties: Item: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: The new definition of the Custom Field. Include every setting that you want to retain or change. To reset every Custom Field setting, specify only the DN and the Guid. If the request omits an attribute, the value reverts to the default. Update: type: object description: The values to change for the Custom Field. Only provide properties you want to change, all other settings will be retained. Core_WebSDK_MetadataWebResponse_updateitem: type: object properties: Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_MetadataWebResponse_items: type: object properties: Items: type: array items: type: object properties: Type: $ref: '#/components/schemas/Core_MetadataType' Label: type: string description: Gets or sets the metadata label Help: type: string description: Gets or sets the help text describing the metadata field. Category: type: string description: The category DN, or **null** if none. DisplayAfter: type: string description: The metadata item after which to render this item Name: type: string description: Gets or sets the name of the metadata item. Guid: type: string description: Gets or sets the Guid of the metadata item. DN: type: string description: The DN. Mandatory: type: boolean description: '**true** if mandatory; otherwise, **false**.' DefaultValues: type: array items: type: string description: Gets or sets the list of default values for this metadata field. AllowedValues: type: array items: type: string description: Gets or sets the list of allowed values for this metadata field. Classes: type: array items: type: string description: Gets or sets the list of schema classes this metadata field applies to LocalizationSet: type: array items: type: object properties: Language: type: string description: '' List: type: array items: type: object properties: Invariant: type: string description: '' Localized: type: string description: '' description: Support class to allow serialization of values for a metadata object description: '' description: Support class to allow serialization of values for a metadata object description: The localization table. MinimumLength: type: integer description: Gets or sets the minimum length of the text field. format: int32 nullable: true MaximumLength: type: integer description: Gets or sets the maximum length of the text field. format: int32 nullable: true Mask: type: string description: Gets or sets the input mask. AllowedCharacters: type: string description: Gets or sets the allowed characters for the text field. RegularExpression: type: string description: Gets or sets the regular expression for the text field. ErrorMessage: type: string description: Gets or sets the error message for the text field. Single: type: boolean description: '**true** if single; otherwise, **false**.' DateOnly: type: boolean description: '**true** if only a date should be selected; otherwise, **false**.' TimeOnly: type: boolean description: '**true** if only a time should be selected; otherwise, **false**.' Policyable: type: boolean description: '**true** if policy is supported; otherwise, **false**.' SchemaAttribute: type: string description: Gets the attribute name used when writing this value to the object store ConfigAttribute: type: string description: Provided for 23.3 and earlier compatibility. Use _SchemaAttribute_ instead RenderHidden: type: boolean description: '**true** if field is hidden; otherwise, **false**.' RenderReadOnly: type: boolean description: '**true** if field is read-only; otherwise, **false**.' description: Common metadata description: A list of all existing Custom Field definitions Result: $ref: '#/components/schemas/Core_MetadataResult' Error: type: string description: Provides an error explanation if the request was not successful, otherwise **null** Core_WebSDK_RightsWebRequest_grantsystemrole: type: object properties: UniversalID: type: string description: The universal ID. Role: type: string description: The Role Core_WebSDK_RightsWebResponse_grantsystemrole: type: object properties: Success: type: boolean description: The subsystem. Core_WebSDK_RightsWebRequest_revokesystemrole: type: object properties: UniversalID: type: string description: The universal ID. Role: type: string description: The Role Core_WebSDK_RightsWebResponse_revokesystemrole: type: object properties: Success: type: boolean description: The subsystem. Core_WebSDK_SecretStoreWebRequest_add: required: - VaultType - Data - Keyname - Namespace - Owner type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Keyname: type: string description: The keyname. Namespace: type: string description: The namespace. Owner: type: string description: The owner. Core_WebSDK_SecretStoreWebResponse_add: type: object properties: VaultID: type: integer description: The vault ID. format: int64 nullable: true Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_availablenamespaces: type: object properties: Namespaces: type: array items: type: string description: The namespaces. Core_WebSDK_SecretStoreWebRequest_associate: required: - VaultID - Name type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: integer description: The int value. format: int64 nullable: true DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebResponse_associate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_dissociate: required: - VaultID type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: integer description: The int value. format: int64 nullable: true DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebResponse_dissociate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebResponse_encryptionkeysinuse: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' EncryptionKeys: type: array items: type: string description: The encryption keys. Core_WebSDK_SecretStoreWebResponse_lookup: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupbyvaulttype: required: - VaultType type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Core_WebSDK_SecretStoreWebResponse_lookupbyvaulttype: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupbyassociation: required: - Name type: object properties: Name: type: string description: The name. StringValue: type: string description: The string value. IntValue: type: integer description: The int value. format: int64 nullable: true DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebResponse_lookupbyassociation: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupassociationbyvaultid: required: - VaultID - Name type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Name: type: string description: The name. Core_WebSDK_SecretStoreWebResponse_lookupassociationbyvaultid: type: object properties: Value: type: string description: The value. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupallassociationsbyvaultid: required: - VaultID type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Name: type: string description: The name. Core_WebSDK_SecretStoreWebResponse_lookupallassociationsbyvaultid: type: object properties: TypedNameValues: type: array items: type: object properties: Name: type: string description: The name. Type: type: string description: The type. Value: type: string description: The value. description: Class representing a store association item description: The typed name values. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_mutate: required: - VaultID - VaultType type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' StringValue: type: string description: The string value. IntValue: type: integer description: The int value. format: int64 nullable: true DateValue: type: string description: The date value. Core_WebSDK_SecretStoreWebResponse_mutate: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_lookupbyowner: required: - Namespace - Owner type: object properties: Namespace: type: string description: The namespace. Owner: type: string description: The owner. VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Core_WebSDK_SecretStoreWebResponse_lookupbyowner: type: object properties: VaultIDs: type: array items: type: integer format: int64 description: The vault IDs. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_owneradd: required: - VaultID - Namespace - Owner type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Namespace: type: string description: The namespace. Owner: type: string description: The owner. Core_WebSDK_SecretStoreWebResponse_owneradd: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_ownerdelete: required: - Namespace - Owner type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Namespace: type: string description: The namespace. Owner: type: string description: The owner. Core_WebSDK_SecretStoreWebResponse_ownerdelete: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_ownerlookup: required: - VaultID - Namespace type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Namespace: type: string description: The namespace. Core_WebSDK_SecretStoreWebResponse_ownerlookup: type: object properties: Owners: type: array items: type: string description: The owners. Result: $ref: '#/components/schemas/Core_SecretStoreResult' Error: type: string description: A failure explanation if _Result_ is not _Success_ Core_WebSDK_SecretStoreWebRequest_retrieve: required: - VaultID type: object properties: VaultID: type: integer description: The type of the vault. format: int64 nullable: true Core_WebSDK_SecretStoreWebResponse_retrieve: type: object properties: VaultType: $ref: '#/components/schemas/Nullable_1_Core_VaultType_' Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_SecretStoreWebResponse_rotatekey__vaultid_: type: object properties: Result: $ref: '#/components/schemas/Core_SecretStoreResult' Core_WebSDK_WorkflowTicketsWebRequest_ticket_create: required: - WorkflowDN - Approvers - ObjectDN - Reason - UserData type: object properties: WorkflowDN: type: string description: The distinguished name of the workflow. Approvers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: A list of approvers for the workflow ticket. ObjectDN: type: string description: The distinguished name of the object the workflow ticket is associated with. Reason: type: integer description: The reason for creating the workflow ticket. format: int32 nullable: true UserData: type: string description: User-specific data associated with the workflow ticket. Core_WebSDK_WorkflowTicketsWebResponse: type: object properties: GUID: type: string description: The unique identifier for the created workflow ticket. GUIDs: type: array items: type: string description: A list of GUIDs associated with the workflow ticket. Result: $ref: '#/components/schemas/Core_WorkflowResult' IssuedDueTo: type: string description: The reason the workflow ticket was issued. Status: type: string description: The status of the workflow ticket. Created: type: string description: The creation time of the workflow ticket. Updated: type: string description: The last updated time of the workflow ticket. Blocking: type: string description: Indicates if the workflow ticket is blocking. ApprovalFrom: type: string description: The approver of the workflow ticket (obsolete). Approvers: type: array items: type: string description: A list of approvers for the workflow ticket. ApprovalReason: type: string description: The reason for the approval of the workflow ticket. ApprovalExplanation: type: string description: The explanation for the approval of the workflow ticket. ScheduledStart: type: string description: The scheduled start time for the workflow ticket. ScheduledStop: type: string description: The scheduled stop time for the workflow ticket. description: '' Core_WebSDK_WorkflowTicketsWebRequest_ticket_delete: required: - GUID type: object properties: GUID: type: string description: The unique identifier for the workflow ticket. Core_WebSDK_WorkflowTicketsWebRequest_ticket_details: required: - GUID type: object properties: GUID: type: string description: The unique identifier for the workflow ticket. Core_WebSDK_WorkflowTicketsWebRequest_ticket_enumerate: type: object properties: ObjectDN: type: string description: The distinguished name of the object the workflow ticket is associated with. UserData: type: string description: User-specific data associated with the workflow ticket. Core_WebSDK_WorkflowTicketsWebRequest_ticket_exists: required: - GUID type: object properties: GUID: type: string description: The unique identifier for the workflow ticket. Core_WebSDK_WorkflowTicketsWebRequest_ticket_status: required: - GUID type: object properties: GUID: type: string description: The unique identifier for the workflow ticket. Core_WebSDK_WorkflowTicketsWebRequest_ticket_updatestatus: required: - GUID - Status type: object properties: GUID: type: string description: The unique identifier for the workflow ticket. Status: type: string description: The status of the workflow ticket. Explanation: type: string description: An explanation for the workflow ticket. ScheduledStart: type: string description: The scheduled start time for the workflow ticket. ScheduledStop: type: string description: The scheduled stop time for the workflow ticket. Core_WebSDK_LogWebRequest_evaluatemacro: required: - MacroSource - ID type: object properties: MacroSource: type: string description: The macro text to translate ID: type: integer description: The event ID of the event to simulate format: int32 Severity: $ref: '#/components/schemas/Core_Severity' Component: type: string description: The component value for the simulated event Text1: type: string description: The Text1 value for the simulated event Text2: type: string description: The Text2 value for the simulated event Value1: type: integer description: The Value1 value for the simulated event format: int32 Value2: type: integer description: The Value2 value for the simulated event format: int32 Core_WebSDK_LogWebResponse_evaluatemacro: type: object properties: MacroResult: type: string description: The translated macro output LogResult: $ref: '#/components/schemas/Core_LogResult' Error: type: string description: Error description if the request was not successful WebSDK_Log_LogAdaptableResponse: type: object properties: Scripts: type: array items: type: object properties: Name: type: string description: Name of the script Hash: type: string description: Hash of the script content Fields: type: array items: type: object properties: Name: type: string description: Field name Label: type: string description: Label to display for field Required: type: boolean description: '**true** if the field must be provided' description: Describes a entry field for a script description: The input fields associated with the script description: Record describing a Log Adaptable PowerShell script description: List of available Log Adaptable PowerShell scripts ScriptErrors: type: array items: type: string description: Error information about stored unusable scripts description: Response for AdaptableInformation endpoint. Ssh_WebSDK_AuthRulesResponse: type: object properties: TotalCount: type: integer description: The total number of rules that match the specified search filters. format: int32 DataRange: type: string description: The data range for the current page, i.e., 20-50. Rules: type: array items: type: object properties: Account: type: string description: The account of the rule. Host: type: string description: The host of the rule. KeyAlgorithm: type: string description: "Possible values:\r\n\r\n| OID | Key type | Description |\r\n|-----|-----------|-------------|\r\ \n|1.3.6.1.4.1.28783.10.1.1.1024|ssh-rsa|RSA 1024. Not recommended for high-security applications.|\r\n\ |1.3.6.1.4.1.28783.10.1.1.2048|ssh-rsa|RSA 2048.|\r\n|1.3.6.1.4.1.28783.10.1.1.3072|ssh-rsa|RSA 3072.|\r\ \n|1.3.6.1.4.1.28783.10.1.1.4096|ssh-rsa|RSA 4096.|\r\n|1.3.6.1.4.1.28783.10.8.1024|ssh-dss|DSA 1024. Outdated\ \ and insecure. Not recommended for high-security applications.|\r\n|1.3.6.1.4.1.28783.10.8.2048|ssh-dss|DSA\ \ 2048. Outdated and insecure. Not recommended for high-security applications.|\r\n|1.3.6.1.4.1.28783.10.8.3072|ssh-dss|DSA\ \ 3072. Outdated and insecure. Not recommended for high-security applications.|\r\n|1.3.6.1.4.1.28783.10.8.4096|ssh-dss|DSA\ \ 4096. Outdated and insecure. Not recommended for high-security applications.|\r\n|1.3.6.1.4.1.28783.10.2.1.256|ecdsa-sha2-nistp256|ECC\ \ 256.|\r\n|1.3.6.1.4.1.28783.10.2.1.384|ecdsa-sha2-nistp384|ECC 384.|\r\n|1.3.6.1.4.1.28783.10.2.1.521|ecdsa-sha2-nistp521|ECC\ \ 521.|\r\n|1.3.6.1.4.1.28783.10.3.25519|ssh-ed25519|ED25519.|" KeyFingerprint: type: string description: The key fingerprint of the rule. FirstHit: type: string description: The first hit date of the rule in ISO 8601 format. LastHit: type: string description: The last hit date of the rule in ISO 8601 format. HitCount: type: string description: The hit count of the rule being returned. description: Key authorization rule object. description: The list of rules being returned. ErrorDetails: type: string description: The error details, if an error was encountered querying for the rules. description: Result class containing list of key authorization rules as well as paging links and count information. Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest: type: object properties: KeysetFilter: type: object properties: DeviceGuid: type: array items: type: string description: "An array of GUIDs that identify devices.\r\nExample: DeviceGuid: [\"{6955f049-19c5-412a-ad99-974fa4a4183e}\"\ ]" Username: type: array items: type: string description: An array of names of users that own the keys. Length: type: array items: type: integer format: int64 description: "An array of key lengths.\r\nExample: Length: [1024]" MaxKeyLength: type: integer description: The maximum allowed key length. format: int32 Algorithm: type: array items: type: string description: "An array of key algorithms. Supported values: DSA, RSA, or RSA1.\r\nExample: Algorithm: [RSA]" PkixParameterSet: type: array items: type: string description: An array of PKIX Parameter Set values describing the key algorithms. ProcessStatus: type: array items: type: integer format: int32 description: The result that occurred while processing keys. ViolationStatus: type: array items: type: integer format: int32 description: An array of various key violation status codes for a keyset. Type: type: string description: 'The type of keyset: Host or User.' UsageFilterType: type: string description: 'The type of usage filter: NeverUsed, UnusedSince, or UsedSince. Use in conjunction with LastUsed to specify a date.' LastUsed: type: string description: "The date to use in conjunction with UsageFilterType. Specify the date in the Epoch format.\r\n\ Example: LastUsed: /Date(1443449923000+0000)/)." nullable: true AuthorizedKeyComment: type: array items: type: string description: An array of authorized key comments. FingerprintSHA256: type: array items: type: string description: An array of sha256 fingerprints. FingerprintMD5: type: array items: type: string description: An array of md5 fingerprints. description: Filter details for keysets SshKeyUsageFilter: type: object properties: ServerName: type: array items: type: string description: "An array of authorized server IP addresses, full names, or partial names that provide keys to\ \ ClientName. Also known as the target device.\r\nFor example, host715.test.com." ServerAccount: type: array items: type: string description: "An array of authorized server account names that provide keys to ClientName.\r\nFor example, Admin." ClientName: type: array items: type: string description: "An array of client IP addresses, full names, or partial names that can that connect to ServerAccount\ \ with a corresponding key pair. Also known as the source device.\r\nFor example, 10.240.102.94." Alert: type: array items: type: integer format: int32 description: "An array of key usage alerts found on the Server:\r\n1 = An orphan key.\r\n2 = A key that does\ \ not belong to any client." description: Filter details for key usage SshDeviceFilter: type: object properties: DeviceName: type: array items: type: string description: List of host names to search. Partial match is allowed. Type: type: string description: "Only one type of Ssh Device. If not specified, all devices are returned.\r\nClient = Return all\ \ devices containing client keys(user and known host keys).\r\nServer = Return all devices containing server\ \ keys(host and authorized keys).\r\nClientServer = Return all devices containing both client and server keys." IsCompliant: type: boolean description: Whether the device has any issues with SSH key compliance. nullable: true description: Filter details for devices PageSize: type: integer description: Page size format: int32 Offset: type: integer description: Starting page format: int32 LoadKeyData: type: boolean description: Load the key data deviceGuids: type: array items: type: string description: List of device GUIDs KeyId: type: array items: type: integer format: int64 description: List of key IDs description: Data object IList_1_Ssh_WebSDK_DataContract_TestDeviceConnectionResult_: type: array items: type: object properties: DeviceGuid: type: string description: The Device Identifier. Success: type: boolean description: Whether connection to the device was successful Error: type: string description: Error description description: Stores device Ssh_WebSDK_DataContract_Requests_KeyUsageData: type: object properties: LogData: type: array items: type: object properties: LogRecord: type: string description: Log data LogUtcEpochDate: type: string description: Date/Time of the event, in seconds since 1970 description: A log entry description: An array of SysLog entries. description: The class for key usage request. Ssh_WebSDK_DataContract_SshWebResponse: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: Contains the response information for arbitrary action. Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest_KeyUsage: required: - SshKeyUsageFilter - PageSize - Offset type: object properties: SshKeyUsageFilter: type: object properties: ServerName: type: array items: type: string description: "An array of authorized server IP addresses, full names, or partial names that provide keys to\ \ ClientName. Also known as the target device.\r\nFor example, host715.test.com." ServerAccount: type: array items: type: string description: "An array of authorized server account names that provide keys to ClientName.\r\nFor example, Admin." ClientName: type: array items: type: string description: "An array of client IP addresses, full names, or partial names that can that connect to ServerAccount\ \ with a corresponding key pair. Also known as the source device.\r\nFor example, 10.240.102.94." Alert: type: array items: type: integer format: int32 description: "An array of key usage alerts found on the Server:\r\n1 = An orphan key.\r\n2 = A key that does\ \ not belong to any client." description: Filter details for key usage PageSize: type: integer description: Page size format: int32 Offset: type: integer description: Starting page format: int32 Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshKeyUsageData_: type: object properties: Data: type: array items: type: object properties: KeyUsageId: type: integer description: Key Usage Record Identifier. format: int32 ServerName: type: string description: Server hostname/IP, represented as a string. ServerAccount: type: string description: Server account name that was accessed. ClientName: type: string description: The host client name or full name of the device. Fingerprint: type: string description: Fingerprint of a key that was used for access. AuthorizedKeyId: type: integer description: Id of the authorized key that allowed the access. Can be null if authorized key is not found in TPP database. format: int64 nullable: true PrivateKeyId: type: integer description: Id of the private key that was used. Can be null if matching private key is not found in the Trust Protection Foundation database. format: int64 nullable: true Alert: $ref: '#/components/schemas/Nullable_1_Ssh_WebSDK_DataContract_SshKeyUsageAlert_' LastUsed: type: string description: The last time the client device tried to use this key to connect to this device. KeysetId: type: string description: The identifier for a set of public and private keys that is valid for the device. description: Stores detailed key usage information. description: Array with one page of data. description: Contains the response information for paginated queries. Ssh_WebSDK_DataContract_Requests_KeyWebRequest: type: object properties: KeyId: type: string description: Key Identifier description: The class for key request. Ssh_WebSDK_DataContract_Requests_KeySetWebRequest: type: object properties: KeysetId: type: string description: The keyset identifier of a set of public and private key pairs. You can get the appropriate KeysetId, from the Aperture inventory. description: The class for keyset request. Ssh_WebSDK_DataContract_Requests_KeyOptionsWebRequest: type: object properties: KeyId: type: string description: Numeric identifier of the authorized key. If the KeyId does not map to an authorized key, the error is "Failed to find key." AllowedSourceRestriction: type: array items: type: string description: List of allowed IP addresses for the key. If omitted, existing value is not changed. DeniedSourceRestriction: type: array items: type: string description: List of denied IP addresses for the key. If omitted, existing value is not changed. ForcedCommand: type: string description: The SSH command for connections that use the authorized key. If omitted, existing value is not changed. Options: type: array items: type: string description: "List of authorized key options. If omitted, existing value is not changed: no-x11-forwarding, no-agent-forwarding,\ \ no-pty, no-port-forwarding, permitopen, environment, cert-authority, principals, tunnel, allow-from, deny-from,\ \ from, command.\r\nFor additional help, see https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#Available_key_login_options." description: The class for key options request. Ssh_WebSDK_DataContract_Requests_EditSelfServiceAuthorizedKeyWebRequest: type: object properties: Location: type: string description: Key location. Notes: type: string description: Arbitrary notes AllowedSourceRestriction: type: array items: type: string description: List of allowed source restrictions for the key. DeniedSourceRestriction: type: array items: type: string description: List of denied source restrictions for the key. ForcedCommand: type: string description: Forced command for connections with the key. Options: type: array items: type: string description: List of authorized key options. description: The class for editing selfservice authorized key request. Ssh_WebSDK_DataContract_Requests_AddSelfServicePrivateKeyWebRequest: type: object properties: Owner: type: string description: Identity that will own the key. ContactEmail: type: string description: (optional) email of contact, optional. will be used if actual owner is outside of organization FolderId: type: string description: GUID of a Folder to add key to. Location: type: string description: Key location. Notes: type: string description: Arbitrary notes KeysetId: type: string description: The keyset that this key will be added to. If not specified, new keyset will be created. description: The class for adding selfservice private key request. Ssh_WebSDK_DataContract_AddSelfServiceKeyWebResponse: type: object properties: KeyId: type: integer description: Identifier of newly created key format: int64 KeysetId: type: string description: Identifier of keyset new key is located in. Notes: type: string description: Notes for manual key Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation description: The class for adding selfservice private key response. Ssh_WebSDK_DataContract_Requests_AddSelfServiceAuthorizedKeyWebRequest: type: object properties: Owner: type: string description: Identity that will own the key. ContactEmail: type: string description: (optional) email of contact, optional. will be used if actual owner is outside of organization FolderId: type: string description: GUID of a Folder to add key to. Location: type: string description: Key location. Notes: type: string description: Arbitrary notes KeysetId: type: string description: The keyset that this key will be added to. AllowedSourceRestriction: type: array items: type: string description: List of allowed source restrictions for the key. DeniedSourceRestriction: type: array items: type: string description: List of denied source restrictions for the key. ForcedCommand: type: string description: Forced command for connections with the key. Options: type: array items: type: string description: List of authorized key options. description: The class for adding selfservice authorized key request. Ssh_WebSDK_DataContract_Requests_KeysetToPolicyWebRequest: type: object properties: KeysetIds: type: array items: type: string description: The keysets id's. PolicyDN: type: string description: The policy DN. PolicyPath: type: string description: The dn path. description: The class for keyset to policy migration. Ssh_WebSDK_DataContract_Requests_ExportSelfServiceKeyRequest: type: object properties: KeyId: type: integer description: The identifier of key to download. To get the KeyId, use GET SSH/KeysetDetails. format: int64 Format: type: string description: "(Optional) Format of the key material: OpenSSH, SSH2, PuTTY (only for private keys).\r\nIf format\ \ is not specified, the value is taken from policy. If the policy format is not specified, the default is OpenSSH." description: The class for exporting selfservice key request. Ssh_WebSDK_DataContract_ExportSelfServiceKeyResponse: type: object properties: Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation KeyMaterial: type: string description: Self service key material description: The class for exporting selfservice key response. Ssh_WebSDK_DataContract_Requests_ExportSelfServicePrivateKeyRequest: type: object properties: Passphrase: type: string description: "(Optional) The passphrase to use to encrypt the key.\r\nTo specify a passphrase, use your own company\ \ standards or follow the guidelines from the National Institute of Standards and Technology (NIST)." KeyId: type: integer description: The identifier of key to download. To get the KeyId, use GET SSH/KeysetDetails. format: int64 Format: type: string description: "(Optional) Format of the key material: OpenSSH, SSH2, PuTTY (only for private keys).\r\nIf format\ \ is not specified, the value is taken from policy. If the policy format is not specified, the default is OpenSSH." description: The class for exporting selfservice key request. Ssh_WebSDK_DataContract_Requests_AddUserPrivateKeyWebRequest: type: object properties: DeviceGuid: type: string description: GUID of a Device to add key to. Username: type: string description: Name on user specified device that will own the key. Filepath: type: string description: Path of the file with the key. KeysetId: type: string description: Keyset to add the key to. If not specified, new keyset will be created. Format: type: string description: 'Format of the key. Can be one of: OpenSSH, SSH2, PuTTY. Can be omitted if specified on device policy.' Passphrase: type: string description: Passphrase to encrypt the new key. PolicyDN: type: string description: The DN of the policy where the keyset will be created. description: The class for adding user private key request. Ssh_WebSDK_DataContract_AddUserPrivateKeyWebResponse: type: object properties: KeyId: type: integer description: Identifier of newly created key format: int64 KeysetId: type: string description: Identifier of keyset new key is located in. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation description: The class for adding user private key response. Ssh_WebSDK_DataContract_Requests_AddHostPrivateKeyWebRequest: type: object properties: DeviceGuid: type: string description: GUID of a Device to add key to. Username: type: string description: Name on user specified device that will own the key. Filepath: type: string description: Path of the file with the key. KeysetId: type: string description: Keyset to add the key to. If not specified, new keyset will be created. Format: type: string description: 'Format of the key. Can be one of: OpenSSH, SSH2, PuTTY. Can be omitted if specified on device policy.' PolicyDN: type: string description: The DN of the policy where the keyset will be created. description: The class for adding host private key request. Ssh_WebSDK_DataContract_AddHostPrivateKeyWebResponse: type: object properties: KeyId: type: integer description: Identifier of newly created key format: int64 KeysetId: type: string description: Identifier of keyset new key is located in. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation description: The class for adding host private key response. Ssh_WebSDK_DataContract_Requests_AddAuthorizedKeyWebRequest: type: object properties: DeviceGuid: type: string description: GUID of a Device to add key to. Username: type: string description: Name on user specified device that will own the key. Filepath: type: string description: Name on user specified device that will own the key. KeysetId: type: string description: Keyset to add the key to. AllowedSourceRestriction: type: array items: type: string description: List of allowed source restrictions for the key. If omitted, the value is taken from device policy. DeniedSourceRestriction: type: array items: type: string description: List of denied source restrictions for the key. If omitted, the value is taken from device policy. ForcedCommand: type: string description: Forced command for connections with the key. If omitted, the value is taken from device policy. Options: type: array items: type: string description: List of authorized key options. If omitted, the value is taken from device policy. Format: type: string description: 'Format of the key. Can be one of: OpenSSH, SSH2. Can be omitted if specified on device policy.' TrailingComment: type: string description: The trailing comment of the authorized key. description: The class for adding authorized key request. Ssh_WebSDK_DataContract_AddKeyWebResponse: type: object properties: KeyId: type: integer description: Identifier of newly created key format: int64 Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation description: The class for adding key response. Ssh_WebSDK_DataContract_Requests_AddKnownHostKeyWebRequest: type: object properties: DeviceGuid: type: string description: GUID of a Device to add key to. Username: type: string description: Name on user specified device that will own the key. Filepath: type: string description: Path of the file with the key. KeysetId: type: string description: Keyset to add the key to. Format: type: string description: 'Format of the key. Can be one of: OpenSSH, SSH2. Can be omitted if specified on device policy.' description: The class for adding knownhost key request. Ssh_WebSDK_DataContract_Requests_AuthorizedKeyData: type: object properties: KeyContentBase64: type: string description: Base64 contents of public key file, in OpenSSH or SSH2 format. For Tectia, this should be single key file (not authorization file). DeviceGuid: type: string description: The GUID of a device. Username: type: string description: Name on user specified device that will own the key. Filepath: type: string description: Path of the file. Format: type: string description: 'Format of authorized key. Supported formats: OpenSSH and SSH2.' description: The class for importing authorized key request. Ssh_WebSDK_DataContract_ImportResponse: type: object properties: KeyId: type: integer description: Identifier of newly created key. format: int64 SshWebResponse: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation description: The class for importing key response. Ssh_WebSDK_DataContract_Requests_PrivateKeyData: type: object properties: KeyContentBase64: type: string description: Base64 contents of private key file, in OpenSSH, SSH2 or PuTTY format. DeviceGuid: type: string description: The GUID of a device. Username: type: string description: Name on user specified device that will own the key. Passphrase: type: string description: Passphrase to decrypt the key. To specify a password, use your own company password standards or follow the guidelines from the National Institute of Standards and Technology (NIST). Filepath: type: string description: Path of the file with the key. Format: type: string description: 'Format of the private key. Supported formats: OpenSSH, SSH2 and PuTTY.' description: The class for importing private key request. Ssh_WebSDK_DataContract_Requests_ChangePrivateKeyPassphraseRequest: type: object properties: KeyId: type: integer description: Private key ID format: int64 Passphrase: type: string description: New passphrase description: To change parivate key passphrase Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetRequest: type: object properties: UnmatchedTrustId: type: string description: Unmatched keyset trust ID Passphrase: type: string description: Unmatched encrypted private key passphrase description: The class for working with unmatched encrypted keyset Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetDeleteRequest: type: object properties: UnmatchedTrustId: type: string description: Unmatched keyset trust ID description: The class for working with a deletion of a unmatched encrypted keyset IList_1_Ssh_WebSDK_DataContract_KeyData_: type: array items: type: object properties: KeyId: type: integer description: The key identifier. format: int64 KeysetId: type: string description: The identifier for a set of public and private keys. Type: type: string description: 'The key type. One of: UserPrivateKey, UserPublic, HostPrivate, HostPublic, KnownHost, Authorized' Length: type: integer description: The key bit length. format: int32 Algorithm: type: string description: 'The algorithm of a key. Supported values: RSA and ECDSA (for P256, P384, P521).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. DeviceGuid: type: string description: The Trust Protection Foundation Guid that uniquely identifies a device. FilePath: type: string description: The absolute file path location for the key. ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status codes. ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeyProcessStatus' ActiveFrom: type: string description: The date when key was created (either in Aperture or remote system). Expressed in milliseconds since January 1, 1970 with a timezone offset suffix when using the JSON Date function. nullable: true Format: type: string description: 'The format of the key. Can be one of: OpenSSH, SSH2, PuTTY, SSH1.' AllowedSourceRestriction: type: array items: type: string description: The list of allowed source restrictions for the key if they are specified. Not present if key type is not Authorized. DeniedSourceRestriction: type: array items: type: string description: The list of denied source restrictions for the key if they are specified. Not present if key type is not Authorized. ForceCommand: type: string description: The forced command for connections with the key if specified. Not present if key type is not Authorized. Options: type: array items: type: string description: The list of authorized key options, expressed as name or name=value. Not present if key type is not Authorized. Username: type: string description: The username of owner of the key. LastUsed: type: string description: The date and time the key was last used. nullable: true ProcessError: type: string description: "Error message, if some key operation failed for this key (for example, the Server Agent was unable\ \ to add a key).\r\nIs only populated if ProcessStatus has a value of FailedToProvision or FailedToRemove." Reason: type: string description: The reason for approval or rejection. Notes: type: string description: The description or comments about the key. IsEncrypted: type: boolean description: 'The setting to show whether the key is encrypted: 0 = not encrypted or 1 = encrypted.' Approver: type: array items: type: string description: "An array of one or more identities for users which are approvers of the pending key operation.\r\ \nIf approver is not set or key operation is not pending approval, an empty list is returned. Example: \"Approver\"\ : [\"local:\\{2a3d9973-f7fc-446b-931f-2335d06b398d}\"]" Comment: type: string description: The comment of the authorized key description: The class for detailed SSH key information. Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshDeviceData_: type: object properties: Data: type: array items: type: object properties: DeviceGuid: type: string description: The Device Identifier. DN: type: string description: The full device DN. Type: type: string description: 'The type of Ssh Device. Can be one of: Client, Server, ClientServer.' HostName: type: string description: The hostname of a device. IsCompliant: type: boolean description: Whether the device has any issues with SSH key compliance. nullable: true description: Stores detailed device information. description: Array with one page of data. description: Contains the response information for paginated queries. Ssh_WebSDK_DataContract_KeysetData: type: object properties: KeysetId: type: string description: The keyset Identifier. Access: type: string description: The aggregated string describing trust relationship (e.g. user@client -> root@server). ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeysetProcessStatus' ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status code(s). Length: type: integer description: The number of bits for the key length. format: int32 nullable: true Algorithm: type: string description: 'The algorithm for key encryption (supported values: RSA, DSA, RSA1).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. Type: type: string description: The type of keyset. Can be User or Host. PrivateKeys: type: array items: type: object properties: KeyId: type: integer description: The key identifier. format: int64 KeysetId: type: string description: The identifier for a set of public and private keys. Type: type: string description: 'The key type. One of: UserPrivateKey, UserPublic, HostPrivate, HostPublic, KnownHost, Authorized' Length: type: integer description: The key bit length. format: int32 Algorithm: type: string description: 'The algorithm of a key. Supported values: RSA and ECDSA (for P256, P384, P521).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. DeviceGuid: type: string description: The Trust Protection Foundation Guid that uniquely identifies a device. FilePath: type: string description: The absolute file path location for the key. ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status codes. ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeyProcessStatus' ActiveFrom: type: string description: The date when key was created (either in Aperture or remote system). Expressed in milliseconds since January 1, 1970 with a timezone offset suffix when using the JSON Date function. nullable: true Format: type: string description: 'The format of the key. Can be one of: OpenSSH, SSH2, PuTTY, SSH1.' AllowedSourceRestriction: type: array items: type: string description: The list of allowed source restrictions for the key if they are specified. Not present if key type is not Authorized. DeniedSourceRestriction: type: array items: type: string description: The list of denied source restrictions for the key if they are specified. Not present if key type is not Authorized. ForceCommand: type: string description: The forced command for connections with the key if specified. Not present if key type is not Authorized. Options: type: array items: type: string description: The list of authorized key options, expressed as name or name=value. Not present if key type is not Authorized. Username: type: string description: The username of owner of the key. LastUsed: type: string description: The date and time the key was last used. nullable: true ProcessError: type: string description: "Error message, if some key operation failed for this key (for example, the Server Agent was\ \ unable to add a key).\r\nIs only populated if ProcessStatus has a value of FailedToProvision or FailedToRemove." Reason: type: string description: The reason for approval or rejection. Notes: type: string description: The description or comments about the key. IsEncrypted: type: boolean description: 'The setting to show whether the key is encrypted: 0 = not encrypted or 1 = encrypted.' Approver: type: array items: type: string description: "An array of one or more identities for users which are approvers of the pending key operation.\r\ \nIf approver is not set or key operation is not pending approval, an empty list is returned. Example: \"\ Approver\": [\"local:\\{2a3d9973-f7fc-446b-931f-2335d06b398d}\"]" Comment: type: string description: The comment of the authorized key description: The class for detailed SSH key information. description: Detailed private keys information. PublicKeys: type: array items: type: object properties: KeyId: type: integer description: The key identifier. format: int64 KeysetId: type: string description: The identifier for a set of public and private keys. Type: type: string description: 'The key type. One of: UserPrivateKey, UserPublic, HostPrivate, HostPublic, KnownHost, Authorized' Length: type: integer description: The key bit length. format: int32 Algorithm: type: string description: 'The algorithm of a key. Supported values: RSA and ECDSA (for P256, P384, P521).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. DeviceGuid: type: string description: The Trust Protection Foundation Guid that uniquely identifies a device. FilePath: type: string description: The absolute file path location for the key. ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status codes. ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeyProcessStatus' ActiveFrom: type: string description: The date when key was created (either in Aperture or remote system). Expressed in milliseconds since January 1, 1970 with a timezone offset suffix when using the JSON Date function. nullable: true Format: type: string description: 'The format of the key. Can be one of: OpenSSH, SSH2, PuTTY, SSH1.' AllowedSourceRestriction: type: array items: type: string description: The list of allowed source restrictions for the key if they are specified. Not present if key type is not Authorized. DeniedSourceRestriction: type: array items: type: string description: The list of denied source restrictions for the key if they are specified. Not present if key type is not Authorized. ForceCommand: type: string description: The forced command for connections with the key if specified. Not present if key type is not Authorized. Options: type: array items: type: string description: The list of authorized key options, expressed as name or name=value. Not present if key type is not Authorized. Username: type: string description: The username of owner of the key. LastUsed: type: string description: The date and time the key was last used. nullable: true ProcessError: type: string description: "Error message, if some key operation failed for this key (for example, the Server Agent was\ \ unable to add a key).\r\nIs only populated if ProcessStatus has a value of FailedToProvision or FailedToRemove." Reason: type: string description: The reason for approval or rejection. Notes: type: string description: The description or comments about the key. IsEncrypted: type: boolean description: 'The setting to show whether the key is encrypted: 0 = not encrypted or 1 = encrypted.' Approver: type: array items: type: string description: "An array of one or more identities for users which are approvers of the pending key operation.\r\ \nIf approver is not set or key operation is not pending approval, an empty list is returned. Example: \"\ Approver\": [\"local:\\{2a3d9973-f7fc-446b-931f-2335d06b398d}\"]" Comment: type: string description: The comment of the authorized key description: The class for detailed SSH key information. description: Detailed public keys information. LastRotationDate: type: string description: The date of the last key rotation. If the key was never rotated, this field is blank. RotationStage: type: integer description: The status of public and private key rotation. format: int32 nullable: true LastUsed: type: string description: The date when the keyset was last used, if information is available. Only present for authorized keys. FingerprintMD5: type: string description: MD5 fingerprint. FingerprintSHA256: type: string description: SHA256 fingerprint. description: Stores detailed SSH keyset information. Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_KeysetData_: type: object properties: Data: type: array items: type: object properties: KeysetId: type: string description: The keyset Identifier. Access: type: string description: The aggregated string describing trust relationship (e.g. user@client -> root@server). ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeysetProcessStatus' ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status code(s). Length: type: integer description: The number of bits for the key length. format: int32 nullable: true Algorithm: type: string description: 'The algorithm for key encryption (supported values: RSA, DSA, RSA1).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. Type: type: string description: The type of keyset. Can be User or Host. PrivateKeys: type: array items: type: object properties: KeyId: type: integer description: The key identifier. format: int64 KeysetId: type: string description: The identifier for a set of public and private keys. Type: type: string description: 'The key type. One of: UserPrivateKey, UserPublic, HostPrivate, HostPublic, KnownHost, Authorized' Length: type: integer description: The key bit length. format: int32 Algorithm: type: string description: 'The algorithm of a key. Supported values: RSA and ECDSA (for P256, P384, P521).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. DeviceGuid: type: string description: The Trust Protection Foundation Guid that uniquely identifies a device. FilePath: type: string description: The absolute file path location for the key. ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status codes. ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeyProcessStatus' ActiveFrom: type: string description: The date when key was created (either in Aperture or remote system). Expressed in milliseconds since January 1, 1970 with a timezone offset suffix when using the JSON Date function. nullable: true Format: type: string description: 'The format of the key. Can be one of: OpenSSH, SSH2, PuTTY, SSH1.' AllowedSourceRestriction: type: array items: type: string description: The list of allowed source restrictions for the key if they are specified. Not present if key type is not Authorized. DeniedSourceRestriction: type: array items: type: string description: The list of denied source restrictions for the key if they are specified. Not present if key type is not Authorized. ForceCommand: type: string description: The forced command for connections with the key if specified. Not present if key type is not Authorized. Options: type: array items: type: string description: The list of authorized key options, expressed as name or name=value. Not present if key type is not Authorized. Username: type: string description: The username of owner of the key. LastUsed: type: string description: The date and time the key was last used. nullable: true ProcessError: type: string description: "Error message, if some key operation failed for this key (for example, the Server Agent\ \ was unable to add a key).\r\nIs only populated if ProcessStatus has a value of FailedToProvision\ \ or FailedToRemove." Reason: type: string description: The reason for approval or rejection. Notes: type: string description: The description or comments about the key. IsEncrypted: type: boolean description: 'The setting to show whether the key is encrypted: 0 = not encrypted or 1 = encrypted.' Approver: type: array items: type: string description: "An array of one or more identities for users which are approvers of the pending key operation.\r\ \nIf approver is not set or key operation is not pending approval, an empty list is returned. Example:\ \ \"Approver\": [\"local:\\{2a3d9973-f7fc-446b-931f-2335d06b398d}\"]" Comment: type: string description: The comment of the authorized key description: The class for detailed SSH key information. description: Detailed private keys information. PublicKeys: type: array items: type: object properties: KeyId: type: integer description: The key identifier. format: int64 KeysetId: type: string description: The identifier for a set of public and private keys. Type: type: string description: 'The key type. One of: UserPrivateKey, UserPublic, HostPrivate, HostPublic, KnownHost, Authorized' Length: type: integer description: The key bit length. format: int32 Algorithm: type: string description: 'The algorithm of a key. Supported values: RSA and ECDSA (for P256, P384, P521).' PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. DeviceGuid: type: string description: The Trust Protection Foundation Guid that uniquely identifies a device. FilePath: type: string description: The absolute file path location for the key. ViolationStatus: type: array items: $ref: '#/components/schemas/ProductLogic_Ssh_Entities_PolicyViolation' description: The key violation status codes. ProcessStatus: $ref: '#/components/schemas/Ssh_WebSDK_DataContract_KeyProcessStatus' ActiveFrom: type: string description: The date when key was created (either in Aperture or remote system). Expressed in milliseconds since January 1, 1970 with a timezone offset suffix when using the JSON Date function. nullable: true Format: type: string description: 'The format of the key. Can be one of: OpenSSH, SSH2, PuTTY, SSH1.' AllowedSourceRestriction: type: array items: type: string description: The list of allowed source restrictions for the key if they are specified. Not present if key type is not Authorized. DeniedSourceRestriction: type: array items: type: string description: The list of denied source restrictions for the key if they are specified. Not present if key type is not Authorized. ForceCommand: type: string description: The forced command for connections with the key if specified. Not present if key type is not Authorized. Options: type: array items: type: string description: The list of authorized key options, expressed as name or name=value. Not present if key type is not Authorized. Username: type: string description: The username of owner of the key. LastUsed: type: string description: The date and time the key was last used. nullable: true ProcessError: type: string description: "Error message, if some key operation failed for this key (for example, the Server Agent\ \ was unable to add a key).\r\nIs only populated if ProcessStatus has a value of FailedToProvision\ \ or FailedToRemove." Reason: type: string description: The reason for approval or rejection. Notes: type: string description: The description or comments about the key. IsEncrypted: type: boolean description: 'The setting to show whether the key is encrypted: 0 = not encrypted or 1 = encrypted.' Approver: type: array items: type: string description: "An array of one or more identities for users which are approvers of the pending key operation.\r\ \nIf approver is not set or key operation is not pending approval, an empty list is returned. Example:\ \ \"Approver\": [\"local:\\{2a3d9973-f7fc-446b-931f-2335d06b398d}\"]" Comment: type: string description: The comment of the authorized key description: The class for detailed SSH key information. description: Detailed public keys information. LastRotationDate: type: string description: The date of the last key rotation. If the key was never rotated, this field is blank. RotationStage: type: integer description: The status of public and private key rotation. format: int32 nullable: true LastUsed: type: string description: The date when the keyset was last used, if information is available. Only present for authorized keys. FingerprintMD5: type: string description: MD5 fingerprint. FingerprintSHA256: type: string description: SHA256 fingerprint. description: Stores detailed SSH keyset information. description: Array with one page of data. description: Contains the response information for paginated queries. Ssh_WebSDK_DataContract_Requests_WorkflowKeyOperationRequest: type: object properties: KeyId: type: string description: An identifier of a public or private key that requires workflow approval. Comment: type: string description: The reason why the operation was approved or rejected. description: The class for workflow key operation request. SshCertificate_WebSDK_DataContract_Requests_RequestNewCertificateWebRequest: type: object properties: CADN: type: string description: The Distinguished Name (DN) of the issuing certificate template which will be used for signing. PolicyDN: type: string description: (Optional) The DN of the policy folder where the certificate object will be created. Omit this parameter if you want the default from the SSH Certificate Issuance Template. ObjectName: type: string description: "(Optional) The friendly name for the certificate object. If not specified, KeyId will be used as friendly\ \ name.\r\nIf certificate object with the same name is already present in the Policy folder (PolicyDN), then the\ \ old certificate is archived, and the CA issues a new certificate." DestinationAddress: type: string description: "(Optional) The destination host where the certificate will authenticate. Specify a Fully Qualified\ \ Domain name (FQDN) or IP address.\r\nOnly applies to client certificates for reporting or auditing." Origin: type: string description: (Optional) Additional information, such as the name and version of the calling application (Origin) RequestedBy: type: string description: Prefixed universal ID of the user which requested the certificate. OriginatingIP: type: string description: The IP of the client which requested the certificate. KeyId: type: string description: The certificate identifier (Key ID) of the requested certificate (usually used to determine ownership). Principals: type: array items: type: string description: (Optional) An array of names for which the requested certificate will be valid. Omit this parameter if you want the template defaults to be used. ValidityPeriod: type: string description: "(Optional) The requested certificate expiration time. Cannot be greater than the maximum certificate\ \ validity configured on template.\r\nIf not provided, the maximum certificate validity configured on template\ \ will be used.\r\n\r\nOne of the following formats:\r\n- Relative time: The format is space delimited in w (weeks)\ \ d (days) h (hours), m (minutes), s (seconds) Example: 1w 2d 3h 4m 50s.\r\n- Universal Time Coordinated (UTC):\ \ One of these formats:\r\n- Calendar date: Use the yyyyMMdd format. For example, 20251217.\r\n- Both date and\ \ time: Use the yyyyMMddHHmmss format. For example, 20211217235900." PublicKeyData: type: string description: "(Optional) The Base-64 encoded public key in OpenSSH format which will be signed. Omit this parameter\ \ if you want the service\r\nto generate a new key pair. The key algorithm must be allowed on the policy.\r\n\ The Comment section at the end of the public key is optional." Extensions: type: object additionalProperties: type: string description: "(Optional) A case sensitive set of key-value pairs that contain certificate extensions. Omit this\ \ parameter\r\nif you want the default from the SSH Certificate Issuance Template. Valid only for client certificates." description: "_This property is a dictionary._ \nkey1: value1 \nkey2: value2 \n..." ForceCommand: type: string description: (Optional) The command to execute after a successful login. Valid only for client certificates. SourceAddresses: type: array items: type: string description: (Optional) An array of one or more valid Classless Inter-Domain Routing (CIDR) addresses that the certificate should be signed for. Valid only for client certificates. PrivateKeyPassphrase: type: string description: The passphrase which will be used to wrap the generated private key before it is returned in the API response. IncludePrivateKeyData: type: boolean description: Whether or not to include the private key material. IncludeCertificateDetails: type: boolean description: Whether or not to include the certificate details in the response. ProcessingTimeout: type: integer description: How much time the server will hold the connection waiting for certificate issuance before a Pending response is returned. format: int32 nullable: true description: The class for new certificate request. SshCertificate_WebSDK_DataContract_RequestCertificateResponse: type: object properties: DN: type: string description: The DN of the created SSH certificate object. Guid: type: string description: A value that uniquely identifies the certificate object. ProcessingDetails: type: object properties: Status: type: string description: The current status of the certificate. StatusDescription: type: string description: Description of the current certificate status description: Provide the processing details of the certificate. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation. description: The class for requesting new certificate response. SshCertificate_WebSDK_DataContract_Requests_RetrieveCertificateWebRequest: type: object properties: PrivateKeyPassphrase: type: string description: The passphrase which will be used to wrap the generated private key before it is returned in the API response. IncludePrivateKeyData: type: boolean description: Whether or not to include the private key material. IncludeCertificateDetails: type: boolean description: Whether or not to include the certificate details in the response. DN: type: string description: The DN of the requested object. Guid: type: string description: A value that uniquely identifies the object. description: The class for retrieve certificate request. SshCertificate_WebSDK_DataContract_RetrieveCertificateResponse: type: object properties: Guid: type: string description: A value that uniquely identifies the certificate request. DN: type: string description: The DN of the created SSH certificate object. CertificateData: type: string description: Base-64 encoded string of the issued certificate. PrivateKeyData: type: string description: The private key in base-64 encoded PEM/OpenSSH format which can be directly consumed by SSH clients. PublicKeyData: type: string description: The public key in base-64 encoded OpenSSH format which can be directly consumed by SSH clients. CAGuid: type: string description: Unique identifier of the CA used to sign the requested certificate. ProcessingDetails: type: object properties: Status: type: string description: The current status of the certificate. StatusDescription: type: string description: Description of the current certificate status RequestDetails: type: object properties: DestinationAddress: type: string description: The class for the processing details response. RequestedBy: type: string description: The class for the processing details response. OriginatingIP: type: string description: The class for the processing details response. CADN: type: string description: The DN of the CA used to sign the requested certificate. CertificateDetails: type: object properties: KeyType: type: string description: The type of the key. CertificateType: type: string description: Indicates whether the issued certificate is for client or host authentication. CertificateFingerprintSHA256: type: string description: Base-64 encoded SHA256 hash of the base-64 part of the issued certificate. CAFingerprintSHA256: type: string description: Base-64 encoded SHA256 hash of the public key of the CA used for signing the requested certificate. PublicKeyFingerprintSHA256: type: string description: Base-64 encoded SHA256 hash of the public key that was signed. KeyID: type: string description: The identifier of the issued certificate. SerialNumber: type: string description: The serial number of the certificate. Principals: type: array items: type: string description: The principals of the issued certificate. ValidFrom: type: integer description: A time in second since 1970-01-01 00:00:00 after the certificate is valid. format: int64 ValidTo: type: integer description: A time in second since 1970-01-01 00:00:00 before the certificate is valid. format: int64 ForceCommand: type: string description: The Force Command of the issued certificate. SourceAddresses: type: array items: type: string description: The Source Addresses of the issued certificate. Extensions: type: object additionalProperties: type: string description: The extensions of the issued certificate. description: "_This property is a dictionary._ \nkey1: value1 \nkey2: value2 \n..." description: The details of the issued certificate. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation. description: The class for retrieving certificate response. List_1_SshCertificate_WebSDK_DataContract_AvailableTemplateResponse_: type: array items: type: object properties: DN: type: string description: The DN of the template. Guid: type: string description: The unique identifier of the template. description: The class defining details of an available for user template. SshCertificate_WebSDK_DataContract_Requests_RetrieveTemplateWebRequest: type: object properties: IncludeCAKeyPairDetails: type: boolean description: Whether or not to include the CA key pair details in the response. DN: type: string description: The DN of the requested object. Guid: type: string description: A value that uniquely identifies the object. description: The class for retrieve template request. SshCertificate_WebSDK_DataContract_RetrieveTemplateResponse: type: object properties: DN: type: string description: The DN of the template. Guid: type: string description: The unique identifier of the template. Name: type: string description: The name of the template. Contacts: type: array items: type: string description: List identities for users or groups who receive notifications about events pertaining to the object. CertificateObjectNamingPattern: type: string description: Pattern used to name the certificate objects dinamically UseCertificateObjectNamingPattern: type: boolean description: Specify if the certificate object's name will be supplied on the request or if it will be built using a naming pattern CreatedOn: type: string description: The creation date of the template. CAKeyPairDN: type: string description: The CA key pair dn of the template. CAKeyPairGuid: type: string description: The CA key pair guid of the template. CAKeyPair: type: object properties: DN: type: string description: The DN of the CA key pair. Guid: type: string description: The unique identifier of the CA key pair. Name: type: string description: The name of the CA key pair PublicKeyData: type: string description: The CA public key of the requested template in a format which can be directly consumed by OpenSSH daemon. FingerprintSHA256: type: string description: Base64 encoded SHA256 hash of the CA public key. KeyAlgorithm: type: string description: DEPRECATED - use PkixParameterSet instead PkixParameterSet: type: string description: The PKIX Parameter Set describing the algorithm and size/curve of the CA key. CreatedOn: type: string description: The creation date of the CA key. description: CAKeyPair section for the template. Certificate: type: object properties: CertificateDestinationDn: type: string description: The DN of the policy folder where issued certificates will be stored by default. Type: type: string description: The type ("client" or "host") of certificates that this template issues. ValidityPeriod: type: string description: The maximum certificate validity period. AllowedPrivateKeyAlgorithms: type: array items: type: string description: The algorithms of the keys that can be sent for signing. DefaultPrivateKeyAlgorithm: type: string description: The key algorithm and size/curve that will be used when a keys need to be generated by the service. SignatureHashingAlgorithm: type: string description: The hashing algorithm which is used when signing certificates. AllowPrivateKeyReuse: type: boolean description: Allow the reuse of the private key. description: Certificate for the template. AccessControl: type: object properties: DefaultPrincipals: type: array items: type: string description: The default principals set on the certificate template AllowedPrincipalsPatterns: type: array items: type: string description: The patterns which will be used to validate the requested principals. AllowedExtensions: type: array items: type: string description: Includes standard and custom extensions allowed to be requested. DefaultExtensions: type: array items: type: string description: DefaultExtensions AllowedSourceAddresses: type: array items: type: string description: AllowedSourceAddresses DefaultSourceAddresses: type: array items: type: string description: DefaultSourceAddresses AllowedCertificateIdentifierPatterns: type: array items: type: string description: AllowedCertificateIdentifierPatterns DefaultCertificateIdentifier: type: string description: DefaultCertificateIdentifier AllowedForceCommandPatterns: type: array items: type: string description: AllowedForceCommandPatterns DefaultForceCommand: type: string description: DefaultForceCommand description: AccessControl section for the template. APIClient: type: object properties: AllowedToRequestPrincipals: type: boolean description: Enable or disable API clients to specify Principals AllowedToRequestExtensions: type: boolean description: Enable or disable API clients to specify Extensions AllowedToRequestForceCommand: type: boolean description: Allow API clients to specify Force Command AllowedToRequestSourceAddresses: type: boolean description: Enable or disable API clients to specify Source Addresses AllowedToRequestCertificateIdentifier: type: boolean description: Enable or disable API clients to specify Certificate Identifier IncludeIssuedCertificateInRequest: type: boolean description: Enable or disable API clients to receive issued certificates in response to their enrollment requests description: APIClient section for the template. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation. description: The class for retrieving ssh certificate template response SshCertificate_WebSDK_DataContract_Requests_CreateNewCAKeypairWebRequest: type: object properties: Name: type: string description: The friendly name of the CA key. ParentDN: type: string description: The DN of the parent container. KeyAlgorithm: type: string description: DEPRECATED - use PkixParameterSet instead PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm which will be used to generate new key material. KeyStorage: type: string description: The location where the key will be generated and stored. PrivateKeyData: type: string description: The private key material which will be imported. PrivateKeyPassphrase: type: string description: The passphrase which will be used to decrypt the PrivateKeyData. description: The class for new CA keypair. SshCertificate_WebSDK_DataContract_CreateCaKeyPairResponse: type: object properties: DN: type: string description: The DN of the object. Guid: type: string description: A value that uniquely identifies the object. Name: type: string description: The name of the CaKeyPair. FingerprintSHA256: type: string description: The SHA256 fingerprint of the public key. KeyAlgorithm: type: string description: DEPRECATED - use PkixParameterSet instead PkixParameterSet: type: string description: The PKIX Parameter Set describing the key algorithm. PublicKeyData: type: string description: The public key data. CreatedOn: type: string description: The creation date of the CaKeyPair object. ProcessingDetails: type: object properties: Status: type: string description: The status. StatusDescription: type: string description: The status description. description: The processing details. KeyStorage: type: string description: The key storage. Response: type: object properties: Success: type: boolean description: "true: The operation succeeded\r\nfalse: The operation failed." ErrorCode: type: integer description: Omitted if Success is true. The code that describes the error if any. format: int32 ErrorMessage: type: string description: Omitted if Success is true.The corresponding error message if any. description: SshWebResponse object with result of the operation. description: The class for requesting new CaKeyPair response. Teams_WebSDK_TeamWebRequest: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity. Name: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The prefixed name of the team to be created. Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. NewTeamName: type: string description: The new name for the team. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of members to be added to the team. ShowMembers: type: boolean description: A flag indicating whether the added members should be returned. Owners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of owners for the team. Products: type: array items: type: string description: The list of products the team should have access to. Assets: type: array items: type: string description: The list of assets for the team. Description: type: string description: The description of the team. description: Class to pass when issuing a Team request. Teams_WebSDK_TeamWebRequest__: required: - Name - Members - Owners - Products - Assets - Description type: object properties: Name: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The prefixed name of the team to be created. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of members to be added to the team. Owners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of owners for the team. Products: type: array items: type: string description: The list of products the team should have access to. Assets: type: array items: type: string description: The list of assets for the team. Description: type: string description: The description of the team. Teams_WebSDK_TeamWebResponse: type: object properties: ID: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The identity of the team. InvalidMembers: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of invalid members. Message: type: string description: The error message, if any. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of members of the team. Owners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of owners of the team. InvalidOwners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of invalid owners of the team. Products: type: array items: type: string description: The list of products the team has access to. Assets: type: array items: type: string description: The list of assets for the team. Description: type: string description: The description of the team. description: Class to pass when issuing a team request Teams_WebSDK_TeamWebRequest_addteammembers: required: - Team - Members type: object properties: Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of members to be added to the team. Teams_WebSDK_TeamWebRequest_removeteammembers: required: - Team - Members - ShowMembers type: object properties: Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. Members: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of members to be added to the team. ShowMembers: type: boolean description: A flag indicating whether the added members should be returned. Teams_WebSDK_TeamWebRequest_addteamowners: required: - Team - ShowMembers - Owners type: object properties: Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. ShowMembers: type: boolean description: A flag indicating whether the added members should be returned. Owners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of owners for the team. Teams_WebSDK_TeamWebRequest_demoteteamowners: required: - Team - ShowMembers - Owners type: object properties: Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. ShowMembers: type: boolean description: A flag indicating whether the added members should be returned. Owners: type: array items: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: Describes an Identity description: The list of owners for the team. Teams_WebSDK_TeamWebRequest_renameteam: required: - Team - NewTeamName type: object properties: Team: type: object properties: Prefix: type: string description: Gets the prefix of the identity provider owning the entry PrefixedName: type: string description: The name of the prefixed. PrefixedUniversal: type: string description: Gets the prefixed universal. Name: type: string description: Gets the name of the entry FullName: type: string description: Gets the full name of the entry Universal: type: string description: Gets the universal (machine-readable) name of the entry IsGroup: type: boolean description: True if the entry represents a group Type: $ref: '#/components/schemas/Core_IdentityType' State: $ref: '#/components/schemas/Core_IdentityEntry_EntryState' description: The name or prefixed universal of the team. NewTeamName: type: string description: The new name for the team. Platform_WebSDK_PlatformWebRequest: type: object properties: Platform: type: string description: The component. description: Class to represent a Platform request for the WebSDK Platform_WebSDK_PlatformWebResponse: type: object properties: Success: type: boolean description: '**true** if the request was successfully completed, **false** otherwise' Error: type: string description: '**null** if the request was successfully completed, a string describing the error otherwise' description: '' securitySchemes: AccessToken: type: http scheme: bearer security: - AccessToken: [] tags: - name: Access Management APIs description: "The endpoints in this section allow you to manage your OAuth environment. \r\nUsing endpoints described in\ \ this section, you can configure your global OAuth properties, assign roles \r\nto identities, create and manage applications,\ \ and create grant rules. After these are in \r\nplace, users can request grants using the authentication server. This\ \ section also includes \r\ndescriptions of endpoints that allow you to view and revoke issued grants." - name: AlgorithmSelector APIs description: The AlgorithmSelector interface provides the ability to retrieve and configure allowed Key Algorithms for policy, key and certificate objects - name: Authentication Server APIs description: "The Auth REST SDK manages authorization bearer tokens. The tokens you need are based on the set of API calls\ \ that your client uses.\r\n\r\n\r\nThe Auth SDK uses the VEDauth service to grant access and manage tokens. No installation\ \ is necessary. \r\nHowever, configuration is required. For more information, see Setting up token authentication." - name: Certificate Management APIs description: "The endpoints in this section manage TLS certificates. If you want certificates to secure SSH keys, see the\ \ _SshCertificates_ section\r\n## PKIX Parameter Set ##\r\nAs of TPP 25.1 algorithms are identified by an OID called PKIX\ \ Parameter Set. The following table lists the OID for each algorithm: \r\n\r\n\r\n\r\n**RSA Algorithms**\r\n\r\n| Algorithm\ \ | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\n| RSA 1024\ \ | 1.3.6.1.4.1.28783.10.1.1.1024| RSA 1024 bits offers moderate security but is now considered vulnerable and outdated\ \ for most modern applications. |\r\n| RSA 2048 | 1.3.6.1.4.1.28783.10.1.1.2048| RSA 2048 bits offers strong security\ \ and is widely used for modern encryption and digital signatures. |\r\n| RSA 3072 | 1.3.6.1.4.1.28783.10.1.1.3072| RSA\ \ 3072 bits provides a higher security level, suitable for long-term protection of sensitive data. |\r\n| RSA 4096 | 1.3.6.1.4.1.28783.10.1.1.4096|\ \ RSA 4096 bits offers very high security, commonly used for highly sensitive data and long-term encryption. |\r\n| RSA\ \ 8192 | 1.3.6.1.4.1.28783.10.1.1.8192| RSA 8192 bits provides extremely high security, used for the most sensitive data\ \ and long-term protection. |\r\n| RSA PSS/OAEP 1024 | 1.3.6.1.4.1.28783.10.1.2.1024| RSA 1024 bits PSS provides moderate\ \ security for digital signatures, with PSS offering improved resistance against certain attacks, though it's now considered\ \ vulnerable for most applications. |\r\n| RSA PSS/OAEP 2048 | 1.3.6.1.4.1.28783.10.1.2.2048| RSA 2048 bits PSS offers\ \ strong security with enhanced resistance to forgery and adaptive chosen-message attacks, making it widely used in modern\ \ systems. |\r\n| RSA PSS/OAEP 3072 | 1.3.6.1.4.1.28783.10.1.2.3072| RSA 3072 bits PSS provides enhanced security for\ \ long-term digital signature protection, with PSS improving resistance to certain signature-related attacks. |\r\n| RSA\ \ PSS/OAEP 4096 | 1.3.6.1.4.1.28783.10.1.2.4096| RSA 4096 bits PSS provides very high security for digital signatures,\ \ with PSS offering added protection against vulnerabilities in deterministic signature schemes. |\r\n| RSA PSS/OAEP 8192\ \ | 1.3.6.1.4.1.28783.10.1.2.8192| RSA 8192 bits PSS offers extremely high security for critical digital signatures, with\ \ PSS further strengthening resistance to advanced cryptographic attacks and long-term protection. |\r\n\r\n**Elliptic\ \ Curve Digital Signature Algorithms (ECDSA)**\r\n\r\n| Algorithm | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\ \n| ECDSA P-256 | 1.3.6.1.4.1.28783.10.2.1.256| Digital signature algorithm based on the NIST P-256 curve, providing 128-bit\ \ security. |\r\n| ECDSA P-384 | 1.3.6.1.4.1.28783.10.2.1.384| Digital signature algorithm based on the NIST P-384 curve,\ \ providing 192-bit security. |\r\n| ECDSA P-521 | 1.3.6.1.4.1.28783.10.2.1.521| Digital signature algorithm based on\ \ the NIST P-521 curve, providing 256-bit security. |\r\n| Brainpool P-256r1 | 1.3.6.1.4.1.28783.10.2.2.1| Brainpool P256\ \ is a 256-bit elliptic curve offering strong security for digital signatures and key exchange. |\r\n| Brainpool P-384r1\ \ | 1.3.6.1.4.1.28783.10.2.2.2| Brainpool P384 is a 384-bit elliptic curve providing enhanced security for high-assurance\ \ applications. |\r\n| Brainpool P-512r1 | 1.3.6.1.4.1.28783.10.2.2.3| Brainpool P512 is a 512-bit elliptic curve offering\ \ very high security for sensitive data and long-term protection. |\r\n| Brainpool P-160r1 | 1.3.6.1.4.1.28783.10.2.2.4|\ \ Brainpool P160 is a 160-bit curve, offering moderate security for lightweight cryptographic applications. |\r\n| Brainpool\ \ P-160t1 | 1.3.6.1.4.1.28783.10.2.2.5| Brainpool P160T is a 160-bit twisted curve, offering efficient performance and\ \ moderate security for lightweight applications. |\r\n| Brainpool P-192r1 | 1.3.6.1.4.1.28783.10.2.2.6| Brainpool P192\ \ is a 192-bit curve providing a balanced security level for general-purpose cryptography. |\r\n| Brainpool P-192t1 |\ \ 1.3.6.1.4.1.28783.10.2.2.7| Brainpool P192T is a 192-bit twisted curve, optimized for faster cryptographic operations\ \ with improved security. |\r\n| Brainpool P-224r1 | 1.3.6.1.4.1.28783.10.2.2.8| Brainpool P224 is a 224-bit curve offering\ \ strong security for medium-strength cryptographic applications. |\r\n| Brainpool P-224t1 | 1.3.6.1.4.1.28783.10.2.2.9|\ \ Brainpool P224T is a 224-bit twisted Edwards curve, optimized for efficient cryptographic operations with strong security.\ \ |\r\n| Brainpool P-256t1 | 1.3.6.1.4.1.28783.10.2.2.10| Brainpool P256T is a 256-bit twisted curve, optimized for faster\ \ operations and improved security in digital signatures and key exchange. |\r\n| Brainpool P-320r1 | 1.3.6.1.4.1.28783.10.2.2.11|\ \ Brainpool P320 is a 320-bit curve providing strong security for cryptographic operations, suitable for high-security\ \ applications. |\r\n| Brainpool P-320t1 | 1.3.6.1.4.1.28783.10.2.2.12| Brainpool P320T is a 320-bit twisted curve, balancing\ \ strong security and efficient performance for cryptographic tasks. |\r\n| Brainpool P-384t1 | 1.3.6.1.4.1.28783.10.2.2.13|\ \ Brainpool P384T is a 384-bit twisted curve providing strong security for digital signatures and key exchange, optimized\ \ for performance and efficiency. |\r\n| Brainpool P-512t1 | 1.3.6.1.4.1.28783.10.2.2.14| Brainpool P512T is a 512-bit\ \ twisted curve, providing very high security and optimized for efficient cryptographic processing. |\r\n| SEC P-256k1\ \ | 1.3.6.1.4.1.28783.10.2.3.1| Sec P256K is a 256-bit curve widely used in Bitcoin and blockchain technologies, optimized\ \ for fast elliptic curve operations. |\r\n| SEC P-224r1 | 1.3.6.1.4.1.28783.10.2.3.2| Sec P224 is a 224-bit curve offering\ \ strong security for general-purpose cryptography, commonly used in digital signatures. |\r\n| SEC P-224k1 | 1.3.6.1.4.1.28783.10.2.3.3|\ \ Sec P224K is a 224-bit curve used in cryptographic applications with an emphasis on fast and efficient operations. |\r\ \n| SEC P-192r1 | 1.3.6.1.4.1.28783.10.2.3.4| Sec P192 is a 192-bit curve providing moderate security for lightweight\ \ cryptographic applications. |\r\n| SEC P-192k1 | 1.3.6.1.4.1.28783.10.2.3.5| Sec P192K is a 192-bit curve widely used\ \ in blockchain and cryptographic systems, optimized for efficient operations. |\r\n\r\n**Edwards Curve Algorithms**\r\ \n\r\n| Algorithm | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\ \n| Ed25519 | 1.3.6.1.4.1.28783.10.3.25519| Ed25519 is a high-security elliptic curve signature algorithm, designed for\ \ fast performance and resistance to side-channel attacks. |\r\n| Ed448 | 1.3.6.1.4.1.28783.10.3.44448| Ed448 is a highly\ \ secure elliptic curve signature algorithm, offering stronger security than ED25519, with a larger key size. |\r\n\r\n\ **ML-DSA Quantum-Safe Algorithms**\r\n\r\n| Algorithm | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\ \n| ML-DSA44 | 1.3.6.1.4.1.28783.10.4.44| ML-DSA44 offers 128-bit quantum security, designed for lightweight applications\ \ that require post-quantum resilience with moderate security. |\r\n| ML-DSA65 | 1.3.6.1.4.1.28783.10.4.65| ML-DSA65 provides\ \ 192-bit quantum security, offering stronger protection against quantum adversaries while maintaining efficiency for\ \ broader use cases. |\r\n| ML-DSA87 | 1.3.6.1.4.1.28783.10.4.87| ML-DSA87 delivers 256-bit quantum security, designed\ \ for high-assurance applications needing robust resistance to future quantum computing threats. |\r\n\r\n**SLH-DSA Quantum-Safe\ \ Algorithms**\r\n\r\n| Algorithm | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\ \n| SLH-DSA-SHA2-128s | 1.3.6.1.4.1.28783.10.5.1.1| SLH-DSA SHA2 128bit Small: Offers 128-bit security with SHA-2, optimized\ \ for small footprint applications. |\r\n| SLH-DSA-SHA2-128f | 1.3.6.1.4.1.28783.10.5.1.2| SLH-DSA SHAKE 128bit Fast:\ \ Delivers 128-bit security with SHAKE, optimized for fast performance. |\r\n| SLH-DSA-SHA2-192s | 1.3.6.1.4.1.28783.10.5.1.3|\ \ SLH-DSA SHA2 192bit Small: Offers 192-bit security with SHA-2, suitable for small footprint applications. |\r\n| SLH-DSA-SHA2-192f\ \ | 1.3.6.1.4.1.28783.10.5.1.4| SLH-DSA SHA2 192bit Fast: Ensures 192-bit security with SHA-2, optimized for fast performance.\ \ |\r\n| SLH-DSA-SHA2-256s | 1.3.6.1.4.1.28783.10.5.1.5| SLH-DSA SHA2 256bit Small: Offers 256-bit security with SHA-2,\ \ suitable for small footprint applications. |\r\n| SLH-DSA-SHA2-256f | 1.3.6.1.4.1.28783.10.5.1.6| SLH-DSA SHA2 256bit\ \ Small: Offers 256-bit security with SHA-2, suitable for small footprint applications. |\r\n| SLH-DSA-Shake-128s | 1.3.6.1.4.1.28783.10.5.1.7|\ \ SLH-DSA SHAKE 128bit Small: Provides 128-bit security with SHAKE, designed for small footprint applications. |\r\n|\ \ SLH-DSA-Shake-128f | 1.3.6.1.4.1.28783.10.5.1.8| SLH-DSA SHAKE 128bit Fast: Ensures 128-bit security with SHAKE, optimized\ \ for fast performance. |\r\n| SLH-DSA-Shake-192s | 1.3.6.1.4.1.28783.10.5.1.9| SLH-DSA SHAKE 192bit Small: Provides 192-bit\ \ security with SHAKE, designed for small footprint applications. |\r\n| SLH-DSA-Shake-192f | 1.3.6.1.4.1.28783.10.5.1.10|\ \ SLH-DSA SHAKE 192bit Fast: Delivers 192-bit security with SHAKE, optimized for fast performance. |\r\n| SLH-DSA-Shake-256s\ \ | 1.3.6.1.4.1.28783.10.5.1.11| SLH-DSA SHAKE 256bit Small: Offers 256-bit security with SHAKE, suitable for small footprint\ \ applications. |\r\n| SLH-DSA-Shake-256f | 1.3.6.1.4.1.28783.10.5.1.12| SLH-DSA SHA2 256bit Fast: Offers 256-bit security\ \ with SHAKE, optimized for fast performance. |\r\n\r\n**Pre-Hash SLH-DSA Quantum-Safe Algorithms**\r\n\r\n| Algorithm\ \ | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\n| HASH-SLH-DSA-SHA2-128s-SHA256\ \ | 1.3.6.1.4.1.28783.10.5.2.1| Pre-Hash SLH-DSA SHA2 128bit Small: Offers 128-bit security with SHA-2, optimized for\ \ small footprint applications. |\r\n| HASH-SLH-DSA-SHA2-128f-SHA256 | 1.3.6.1.4.1.28783.10.5.2.2| Pre-Hash SLH-DSA SHA2\ \ 128bit Fast: Delivers 128-bit security with SHA-2, optimized for fast performance. |\r\n| HASH-SLH-DSA-SHA2-192s-SHA512\ \ | 1.3.6.1.4.1.28783.10.5.2.3| Pre-Hash SLH-DSA SHA2 192bit Small: Offers 192-bit security with SHA-2, suitable for small\ \ footprint applications. |\r\n| HASH-SLH-DSA-SHA2-192f-SHA512 | 1.3.6.1.4.1.28783.10.5.2.4| Pre-Hash SLH-DSA SHA2 192bit\ \ Fast: Ensures 192-bit security with SHA-2, optimized for fast performance. |\r\n| HASH-SLH-DSA-SHA2-256s-SHA512 | 1.3.6.1.4.1.28783.10.5.2.5|\ \ Pre-Hash SLH-DSA SHA2 256bit Small: Offers 256-bit security with SHA-2, suitable for small footprint applications. |\r\ \n| HASH-SLH-DSA-SHA2-256f-SHA512 | 1.3.6.1.4.1.28783.10.5.2.6| Pre-Hash SLH-DSA SHA2 256bit Small: Offers 256-bit security\ \ with SHA-2, suitable for small footprint applications. |\r\n| HASH-SLH-DSA-Shake-128s-Shake128 | 1.3.6.1.4.1.28783.10.5.2.7|\ \ Pre-Hash SLH-DSA SHAKE 128bit Small: Provides 128-bit security with SHAKE, designed for small footprint applications.\ \ |\r\n| HASH-SLH-DSA-Shake-128f-Shake128 | 1.3.6.1.4.1.28783.10.5.2.8| Pre-Hash SLH-DSA SHA2 128bit Fast: Ensures 128-bit\ \ security with SHA-2, optimized for fast performance. |\r\n| HASH-SLH-DSA-Shake-192s-SHAke256 | 1.3.6.1.4.1.28783.10.5.2.9|\ \ Pre-Hash SLH-DSA SHAKE 192bit Small: Provides 192-bit security with SHAKE, designed for small footprint applications.\ \ |\r\n| HASH-SLH-DSA-Shake-192f-SHAke256 | 1.3.6.1.4.1.28783.10.5.2.10| Pre-Hash SLH-DSA SHAKE 192bit Fast: Delivers\ \ 192-bit security with SHAKE, optimized for fast performance. |\r\n| HASH-SLH-DSA-Shake-256s-SHAke256 | 1.3.6.1.4.1.28783.10.5.2.11|\ \ Pre-Hash SLH-DSA SHA2 256bit Small: Offers 256-bit security with SHA-2, suitable for small footprint applications. |\r\ \n| HASH-SLH-DSA-Shake-256f-SHAke256 | 1.3.6.1.4.1.28783.10.5.2.12| Pre-Hash SLH-DSA SHA2 256bit Fast: Offers 256-bit\ \ security with SHAKE, optimized for fast performance. |\r\n\r\n**Composite Quantum-Safe Algorithms**\r\n\r\n| Algorithm\ \ | PKIX Parameter Set | Description |\r\n|-----------|--------------------|--------------------------|\r\n| Composite\ \ ML-DSA44 / PSS2048 | 1.3.6.1.4.1.28783.10.7.1| ML-DSA44 / RSA 2048 PSS combines 128-bit quantum security of ML-DSA44\ \ with RSA2048PSS, suitable for moderate security applications requiring post-quantum and classical resilience. |\r\n\ | Composite ML-DSA44 / RSA2048 | 1.3.6.1.4.1.28783.10.7.2| ML-DSA44 / RSA 2048 combines 128-bit quantum security of ML-DSA44\ \ with RSA 2048, suitable for moderate security applications requiring post-quantum and classical resilience. |\r\n| Composite\ \ ML-DSA44 / Ed25519 | 1.3.6.1.4.1.28783.10.7.3| ML-DSA44 / Ed25519 offers 128-bit quantum security of ML-DSA44 with Ed25519,\ \ optimized for fast and secure digital signatures. |\r\n| Composite ML-DSA44 / ECP256 | 1.3.6.1.4.1.28783.10.7.4| ML-DSA44\ \ / ECP256 provides 128-bit quantum security of ML-DSA44 with ECDSA P-256, ideal for secure communications and data integrity.\ \ |\r\n| Composite ML-DSA65 / PSS3072 | 1.3.6.1.4.1.28783.10.7.5| ML-DSA65 / RSA 3072 PSS combines 192-bit quantum security\ \ of ML-DSA65 with RSA 3072 PSS, suitable for long-term protection and moderate security applications. |\r\n| Composite\ \ ML-DSA65 / RSA3072 | 1.3.6.1.4.1.28783.10.7.6| ML-DSA65 / RSA 3072 offers 192-bit quantum security of ML-DSA65 with\ \ RSA 3072, ideal for secure communications and data integrity. |\r\n| Composite ML-DSA65 / PSS4096 | 1.3.6.1.4.1.28783.10.7.7|\ \ ML-DSA65 / RSA 4096 PSS provides 192-bit quantum security of ML-DSA65 with RSA 4096 PSS, suitable for highly sensitive\ \ data and long-term protection. |\r\n| Composite ML-DSA65 / RSA4096 | 1.3.6.1.4.1.28783.10.7.8| ML-DSA65 / RSA 4096 combines\ \ 192-bit quantum security of ML-DSA65 with RSA 4096, ideal for high-security applications needing long-term protection.\ \ |\r\n| Composite ML-DSA65 / ECP256 | 1.3.6.1.4.1.28783.10.7.9| ML-DSA65 / ECP256 offers 192-bit quantum security of\ \ ML-DSA65 with ECDSA P-256, designed for secure communications and data integrity. |\r\n| Composite ML-DSA65 / ECP384\ \ | 1.3.6.1.4.1.28783.10.7.10| ML-DSA65 / ECP384 offers 192-bit quantum security of ML-DSA65 with ECDSA P-384, ideal for\ \ high-security applications needing long-term protection. |\r\n| Composite ML-DSA65 / Brainpool P-256 | 1.3.6.1.4.1.28783.10.7.11|\ \ ML-DSA65 / Brainpool P-256 provides 192-bit quantum security of ML-DSA65 with Brainpool P-256, designed for secure communications\ \ and data integrity. |\r\n| Composite ML-DSA65 / Ed25519 | 1.3.6.1.4.1.28783.10.7.12| ML-DSA65 / Ed25519 combines 192-bit\ \ quantum security of ML-DSA65 with Ed25519, optimized for fast and secure digital signatures. |\r\n| Composite ML-DSA87\ \ / ECP384 | 1.3.6.1.4.1.28783.10.7.13| ML-DSA87 / ECP384 ensures 256-bit quantum security of ML-DSA87 with ECDSA P-384,\ \ suitable for highly sensitive data and long-term protection. |\r\n| Composite ML-DSA87 / Brainpool P-384 | 1.3.6.1.4.1.28783.10.7.14|\ \ ML-DSA87 / Brainpool P-384 offers 256-bit quantum security of ML-DSA87 with Brainpool P-384, ideal for secure financial\ \ transactions and data integrity. |\r\n| Composite ML-DSA87 / Ed448 | 1.3.6.1.4.1.28783.10.7.15| ML-DSA87 / Ed448 combines\ \ 256-bit quantum security of ML-DSA87 with Ed448, designed for high-security digital signatures and fast performance.\ \ |\r\n| Composite ML-DSA87 / PSS4096 | 1.3.6.1.4.1.28783.10.7.16| ML-DSA87 / RSA 4096 PSS provides 256-bit quantum security\ \ of ML-DSA87 with RSA 4096 PSS, suitable for highly sensitive data and long-term protection. |\r\n| Composite ML-DSA87\ \ / PSS3072 | 1.3.6.1.4.1.28783.10.7.17| ML-DSA87 / RSA 3072 PSS provides 256-bit quantum security of ML-DSA87 with RSA\ \ 3072 PSS, suitable for highly sensitive data and long-term protection. |\r\n| Composite ML-DSA87 / ECP521 | 1.3.6.1.4.1.28783.10.7.18|\ \ ML-DSA87 / ECP521 ensures 256-bit quantum security of ML-DSA87 with ECDSA P-521, suitable for highly sensitive data\ \ and long-term protection. |" - name: Client Management APIs description: "## OSName Definitions ##\r\n\r\n* AIX\r\n* Android\r\n* BlackBerry\r\n* BSD\r\n* HPux\r\n* iOS\r\n* Linux\r\ \n* MacOS\r\n* Other\r\n* Solaris\r\n* Unknown\r\n* Windows\r\n* zOS\r\n\r\n\r\n## ClientType Definitions ##\r\n\r\n|ClientType|Description|\r\ \n|---|---|\r\n|VenafiAgent|Return information about server agent clients|\r\n|AgentJuniorMachine|Return information about\ \ Windows user agent clients running as system|\r\n|AgentJuniorUser|Return information about Windows user agent clients\ \ running as user|\r\n|Portal|Return information about end user portal clients|\r\n|Agentless|Return information about\ \ agentless clients|\r\n|PreEnrollment|Return information about Pre-enrollment user clients|\r\n|iOS|Return information\ \ about IOS clients|\r\n|Android|Return information about Android clients|\r\n\r\n\r\n## WorkType definitions ##\r\n\r\ \n|WorkType|Description|\r\n|---|---|\r\n|Client Agent Configuration Work|The frequency that agents can check in with\ \ the Trust Protection Foundation server to retrieve work assignments and schedules|\r\n|Client Agent Automatic Upgrade\ \ Work|The manner that agents upgrade devices|\r\n|Client Agent Device Placement Work|The manner that agents manage traffic\ \ isolation, scalability, manageability, and serviceability|\r\n|Certificate Provisioning Work|The manner that agents\ \ install certificates on devices|\r\n|Client Agent SSH Discovery Work|The manner that agents discover certificates on\ \ devices|\r\n|Client Agent SSH Provisioning Work|The manner that agents install certificates and keys on UNIX or Linux\ \ devices|\r\n|Client Agent SSH Key Usage Work|The manner that agents monitor SSH Key usage|\r\n|Client User Certificate\ \ Work|The manner that agents enroll certificates on behalf of devices|\r\n|Client Certificate Work|The manner that agents\ \ install certificates for browsers|" - name: CodeSigning APIs description: Code Sign Manager allows you to make REST API calls to manage global configurations, templates, projects, signing applications, and rights. - name: CodeSigning HSM API description: "This API allows you to request digital signing of software and manage signing, authentication, and encryption\ \ keys.\r\n\r\nThis API requires the CyberArk Code Sign Manager product." - name: Configuration APIs description: "## Introduction ##\r\nThe Config interface manages objects, attributes, and policy values. \r\n\r\n\r\n\r\n\ API responses include a `Result` value that describes the result of the API call. If an operation failed, the API call\ \ returns an additional `Error` field that describes the cause of the error" - name: Credential APIs description: "The Credentials interface stores information about credentials for use in requesting certificates \r\nand\ \ other activities. Trust Protection Foundation only stores the credentials you create. Any remote \r\ncredentials remain\ \ only under the management of the parent. For example, a vault or safe manages its \r\nown secrets.\r\n\r\n**What is\ \ the difference between Credentials, Permissions, and Identity?**\r\n* Credentials endpoints manage certificate and other\ \ activities. For more information, see Credentials APIs.\r\n* Identity endpoints manage CyberArk users. For more information,\ \ see Identity APIs.\r\n* Permissions endpoints grant principals (users and groups) privileges to objects within Trust\ \ Protection Foundation. For more information, see Permission APIs." - name: Discovery Management APIs description: The Discovery interface manages certificate, device, and application information from your network. - name: Encryption APIs description: "The Crypto interface provides limited access to the cryptography configuration.\r\n\r\n\r\n\r\nTrust Protection\ \ Foundation installs with two encryption keys, the default Trust Protection Foundation software encryption key, which\ \ is an AES-256 bit \r\nsymmetric key generated using the Windows Data Protection API, and the Null key which is the equivalent\ \ of no encryption. \r\nYou can add additional encryption keys from the Trust Protection Foundation Configuration Console,\ \ including those accessible from PKCS#11-compatible hardware security modules (HSMs)." - name: Flow APIs description: The Flow API manages the sequence of tasks. If one of the tasks is has an 'approval required', Flow Tickets manages that approval. - name: HashiCorp PKI APIs description: "The Public Key Infrastructure (PKI) interface allows Trust Protection Foundation to act as an Intermediate\ \ Certificate \r\nAuthority for certificate vaults. This interface also sends the CSR to the CA to sign.\r\n\r\n\r\n\r\ \nThe signed certificate includes the root, intermediate, and end user certificate chain. Trust Protection Foundation\ \ provisions \r\nthe chain to the vault and stores information about the chain. The vault stores the intermediate and\ \ end user certificates.\r\n\r\n\r\n\r\nThe PKI interface is only available through the Web SDK.However, the HashiCorpVault\ \ PKI application object and Role object appear \r\nin the Policy folder. For other details, see HashiCorp Vault PKI—overview.\r\ \n\r\n\r\n\r\nThis interface is valid only if you purchased a certificate product." - name: Identity APIs description: "The Identity interface manages users and group access. The Web SDK supports the following identity providers\ \ for viewing individuals and groups of users:\r\n\r\n|Provider|Requirements|\r\n|---|---|\r\n|AD|Read only. Allows view\ \ capability from an external Microsoft Active Directory (AD). Requires an Active Directory connection before making API\ \ calls. For more information, see the Administration Guide.|\r\n|LDAP|Read only. Allows view capability from an external\ \ Lightweight Directory Access Protocol (LDAP) data source. Requires setup before making API calls. Use the LDAP Identity\ \ Provider Wizard. For more information, see the Administration Guide.|\r\n|Local|Default. Allows view capability and\ \ password rotation only in Trust Protection Foundation.|\r\n\r\n**What is the difference between Credentials, Permissions,\ \ and Identity?**\r\n* Credentials endpoints manage certificate and other activities. For more information, see Credentials\ \ APIs.\r\n* Identity endpoints manage CyberArk users. For more information, see Identity APIs.\r\n* Permissions endpoints\ \ grant principals (users and groups) privileges to objects within Trust Protection Foundation. For more information,\ \ see Permission API." - name: Legacy Workflow APIs description: "The Workflow/Ticket interface manages certificates in an automated workflow. Trust Protection Foundation engines\ \ rely upon workflow object settings and their assignment to folders for the creation of workflow tickets and their impact\ \ on the objects to which they apply.\r\n\r\n\r\n\r\nThe methods provided in this section allow for workflow tickets to\ \ be generated, updated, and removed independent of Trust Protection Foundation processing, making them applicable to\ \ external use cases that involve Trust Protection Foundation objects. A workflow can now apply to certificate renewal\ \ and provisioning to Windows or SSH devices." - name: Log APIs description: "The Log APIs allow to manage CyberArk application event logs. The Log interface allow for events to be recorded\ \ in the \r\nTrust Protection Foundation log table. Many API method calls do not automatically generate log events. Therefore,\ \ you should consider using the Log API to track events for auditing and troubleshooting purposes.\r\n\r\n\r\n\r\n# Log\ \ server event definitions\r\nThe Log server relies on event definitions to categorize events. You can call POST Log and\ \ these types of event definitions to log events:\r\n\r\n* **Add-on application event definitions**: An optional set of\ \ event definitions that you define for your custom SDK applications. \r\nAdd-on application event definitions use Component\ \ IDs in the 0200-0299 range. This reserved range of Component IDs ensures that your \r\nevent definitions have unique\ \ Event IDs. After a successful import, the event definitions appear in the Logging Event Definitions folder.\r\nFor more\ \ information about importing add-on application event definitions, see the Log Server Administration Guide.\r\n* **Predefined\ \ event definitions**: A set of Trust Protection Foundation event definitions. The event definitions appear in the Logging\ \ Event Definitions folder.\r\nTo see a complete list of Trust Protection Foundation Event Group IDs and error codes,\ \ which are in hexadecimal format, visit our Support article." - name: Metadata APIs description: "The Metadata interface manages Custom Fields for objects that appear in the following places of the UI:\r\n\ \r\n* Certificates\r\n* Devices\r\n* Code Signing Projects\r\n* Code Signing Environments\r\n\r\n\r\n\r\n\r\n# Metadata\ \ Types\r\n\r\n|Type|Name|Description|\r\n|----|----|-----------|\r\n|1|Text|Can accept a single line of text. `MinimumLength`,\ \ `MaximumLength`, `Mask` and `RegularExpression` apply to this field type|\r\n|2|List|Provides the user with a list of\ \ selectable items. `Single` controls if one or more items can be selected|\r\n|3|Choice|Provides the user with options.\ \ if `Single` is **true**, the options are presented as radio-buttons, otherwise they are checkboxes|\r\n|4|Date|Provides\ \ the user with a date/time selector. `DateOnly` and `TimeOnly` apply to this field type|\r\n|5|Identity|Provides the\ \ user with the ability to select an identity. If `Single` is **true**, only one identity can be selected|\r\n\r\n\r\n\ \r\n# Metadata Item (Custom Field Definition)\r\nThe Metadata Item describes a Custom Field.\r\n\r\n|Property name|Data\ \ Type|Description|\r\n|-------------|---------|-----------|\r\n|AllowedCharacters|string|_Optional_: All characters allowed\ \ in values|\r\n|AllowedValues|[string]|_Optional_: An array of allowable values|\r\n|Classes|[string]|An array of schema\ \ classes that can use the custom field|\r\n|SchemaAttribute|string|_Read-Only_: The Custom Field GUID|\r\n|DateOnly|boolean|_For\ \ Date type Custom Fields_: Only ask for date, hide time|\r\n|DN|string|_Read-Only_: The DN of the Custom Field definition\ \ object|\r\n|DefaultValues|[string]|_Optional_: An array of values used set by default on the CustomField|\r\n|Guid|string|_Read-Only_:\ \ The Custom Field GUID|\r\n|Help|string|_Optional_: The tool tip to show the user how to populate the Custom Field|\r\ \n|Label|string|The text that describes the Custom Field in the UI|\r\n|Mandatory|boolean|_Optional_: If **true**, users\ \ must enter a value for the Custom Field in the UI|\r\n|Mask|string|_Optional_: An input mask to use for Text type Custom\ \ Fields. The '#'-character represents characters the user may provide|\r\n|MaximumLength|nullable integer|_Optional_:\ \ The maximum number of characters a user can input for the Custom Field that accepts a string|\r\n|MinimumLength|nullable\ \ integer|_Optional_: The minimum number of characters a user must input for the Custom field that accepts a string|\r\ \n|Name|string|The name (CN) of the Custom Field. Required for `POST metadata/defineitem`, read-only otherwise|\r\n|Policyable|boolean|_Optional_:\ \ If **true**, policy will be applied to a Custom Field|\r\n|RegularExpression|string|_Optional_: The regular expression\ \ to apply to user input in a Text type Custom Field|\r\n|RenderHidden|boolean|_Optional_: If **true**, the UI will not\ \ display the Custom Field|\r\n|RenderReadOnly|boolean|_Optional_: If **true**, the UI will display the Custom Field but\ \ not let the user change it|\r\n|Single|boolean|_Optional_: If **true**, only a single value can be selected for a List\ \ or Choice type Custom Field|\r\n|TimeOnly|boolean|_Optional_: If **true**, only a time can be entered in a Date type\ \ Custom Field|\r\n|Type|integer|The type of the Custom Field. Required for `Post metadata/defineitem`, read-only otherwise|" - name: Permission APIs description: "The Permissions interface enables the management and querying of permissions within CyberArk Trust Protection\ \ Foundation™. \r\nPermissions grant principals (users and groups) privileges to objects within Trust Protection Foundation.\r\ \nIn the Permissions interface, when a HTTP GET retrieves the permissions for a specific principal, both the effective\ \ \r\nand Implicit Permissions are returned.POST, PUT, or DELETE operations in this interface can successfully apply \r\ \nEffective Permissions parameters to principals in different identity providers.\r\n**What is the difference between\ \ Credentials, Permissions, and Identity?**\r\n* Credentials endpoints manage certificate and other activities. For more\ \ information, see Credentials APIs.\r\n* Identity endpoints manage CyberArk users. For more information, see Identity\ \ APIs.\r\n* Permissions endpoints grant principals (users and groups) privileges to objects within Trust Protection Foundation." - name: Platform APIs description: "The ServerStatus endpoints allow you to query if a Trust Protection Foundation is in the active or idle state.\ \ This can be useful in configurations where \r\nthe standby feature is enabled and load balancers are used. This API\ \ allows load balancers, for example, to check server \r\nstatus to determine if a server endpoint should be part of a\ \ balanced group." - name: Processing Engines APIs description: The ProcessingEngines interface assigns and controls how Platforms engines manage information in Policy folders. These features provide a means for load balancing certificate management across a network. - name: Recycle Bin APIs description: The RecycleBin interface allows you to manage old or recently deleted data. - name: SecretStore APIs description: SecretStore APIs - name: SSH Certificate APIs description: The SSH Certificate APIs allow to manage the issuance of special certificates for SSH devices. These endpoints are valid only if you purchased SSH Manager for Machines. - name: SSH Management APIs description: "The SSH Management APIs allow to manage device keys and keysets. This interface is valid only if you purchased\ \ SSH Manager for Machines.\r\n\r\n\r\nAll product-supported operations are exposed via this API, including key operations\ \ (addition, removal, and editing of keys), rotation and \r\nmethods to get the actual state of data. For more information\ \ about the SSH objects, see the Web SDK Object class reference." - name: Statistics APIs description: The Statistics APIs provide metrics about Trust Protection Foundation operations. You can query, group, and filter data and then use it in your own reporting applications. - name: System Status APIs description: "The SystemStatus interface provides status and upgrade information about Trust Protection Foundation engines.\ \ This information also appears in the UI.\r\n# Engine Upgrade Status\r\nEngineUpgradeState describes the following Trust\ \ Protection Foundation upgrade statuses:\r\n\r\n* _Upgrade Complete_: The upgrade completed on all Trust Protection Foundation\ \ engines.\r\n* _Upgrade Blocked_: One or more dependency tasks prevented the upgrade from completing.\r\n* _Upgrade In\ \ Error_: The upgrade encountered an error.\r\n* _Upgrade Running_: The upgrade is to a newer version is in progress.\r\ \n* _Upgrade Pending Install_: The numbers of engines that still have a previous version of Trust Protection Foundation.\ \ An upgrade is required.\r\n\r\n\r\n# Service Status\r\nThe Service status describes engine availability: \r\n\r\n* _Down_:\ \ The service is deemed unavailable for operations. The service is considered down if the TimeSinceLastSeen is greater\ \ than six minutes. When Demo mode is enabled to allow updates every 30 seconds, the service is considered down if TimeSinceLastSeen\ \ is greater than 45 seconds.\r\n* _New_: The vPlatform service never detected operations for this service. The corresponding\ \ timeSinceFirstSeen and TimeSinceLastSeen values are also empty.\r\n* _Unknown_: The IIS status is unknown because the\ \ vPlatform service is not currently available to report the status.\r\n* _Up_: The service is deemed available for operations.\ \ The service is considered up if the TimeSinceLastSeen is less than six minutes. When Demo mode is enabled to allow updates\ \ every 30 seconds, the service is considered up if TimeSinceLastSeen is less than 45 seconds.\r\n\r\n\r\n# Upgrade Status\ \ Summary Details object\r\nThe UpgradeSummary object describes the status of a Trust Protection Foundation upgrade:\r\ \n\r\n\r\n* _Status_: The Engine Upgrade Status.\r\n* _StatusDetails_: Appears only when an upgrade is blocked, in error,\ \ or pending installation. Additional information about the upgrade.\r\n* _UpgradeStartTime_: The UTC start time that\ \ the upgrade began on the first engine.\r\n* _UpgradeStopTime_: The UTC completion time when the last engine finished\ \ the upgrade.\r\n* _CompletedTasks_: The total number of upgrade task across all engines.\r\n* _OriginVersion_: Appears\ \ on any upgrades that occur after 20.1. For example, if you are upgrading to 20.1 or higher for the first time, the value\ \ is omitted. The starting point version prior to Trust Protection Foundation upgrades.\r\n* _TargetVersion_: The intended\ \ Trust Protection Foundation version.\r\n* _RemainingTasks_: Appears only when additional upgrade tasks are present.\r\ \n* _EnginesComplete_: The number of engines that successfully completed the upgrade.\r\n* _EnginesRunning_: The number\ \ of engines that are currently upgrading.\r\n* _EnginesBlocked_: The number of engines blocked by other upgrade tasks\ \ or dependencies.\r\n* _EnginesInError_: The number of engines that are in a failed state. These engines retry every\ \ three minutes.\r\n* _EnginesPendingInstall_: The number of engines that still have a previous version of Trust Protection\ \ Foundation installed. An upgrade is required." - name: Teams APIs description: The Teams interface allows you to associate AD, LDAP, and local Identities to Policy assets and CyberArk products. - name: User Preference APIs description: The Preference APIs allow to manages the caller's user preferences