How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Trust Protection Foundation WebSDK (Venafi Trust Protection Platform)

The self-hosted Venafi / CyberArk Trust Protection Foundation Web SDK, version 26.1.1. 388 operations across 364 paths covering certificate management, discovery, identity and permissions, OAuth application/scope administration (/vedauth, /vedsdk/oauth), SSH certificates and authorized keys, code signing and HSM, SecretStore, flows, recycle bin, processing engines, statistics and system status. Because the product is customer-installed, the contract publishes a templated server (https://{dnsname}/) rather than a vendor host.

Trust Protection Foundation WebSDK (Venafi Trust Protection Platform) is one of 2 APIs that Venafi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Certificates, PKI, SSH, Code Signing, and Machine Identity. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 389 operations across 364 paths, organized into 28 resource areas, and defines 656 schemas. It is described by OpenAPI 3.0.1, at version 26.1.1.

Requests are made against 3 base URLs: /, https://REPLACEdnsnameME/, https://{dnsname}/.

389 operations 364 paths 656 schemas 11 DELETE54 GET1 HEAD308 POST15 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
26.1.1
Base URL
https://{dnsname}/
Authentication
HTTP Bearer
Resource Areas
28

Authentication & Security 1

Trust Protection Foundation WebSDK (Venafi Trust Protection Platform) declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessToken). By default, every request must be authenticated.

Paths & Operations 389

Across 364 paths, the API surfaces 389 operations — 11 DELETE, 54 GET, 1 HEAD, 308 POST, 15 PUT. They span 28 resource areas, including HashiCorp PKI APIs, Authentication Server APIs, Certificate Management APIs, Discovery Management APIs, CodeSigning APIs, Credential APIs, CodeSigning HSM API, System Status APIs, and 20 more. Each is listed below with its method, path, parameters, and response codes.

HashiCorp PKI APIs 11

The Public Key Infrastructure (PKI) interface allows Trust Protection Foundation to act as an Intermediate Certificate Authority for certificate vaults. This interface also sends…

POST
/vedsdk/pki/hashicorp/role/
Create a role
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Create body → 200403400401
DELETE
/vedsdk/pki/hashicorp/role/{guid}
Remove policy enforcement settings
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Delete 1 param → 200403400401
GET
/vedsdk/pki/hashicorp/role/{guid}
Retrieve policy information
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_GetByGuid 1 param → 200403400401
PUT
/vedsdk/pki/hashicorp/role/{guid}
Update Trust Protection Foundation info
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiRoles_Update 1 param → 200403400401
POST
/vedsdk/pki/hashicorp/ca/{guid}
Create or update roles
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_EnforceRoles 1 param → 200403400401
GET
/vedsdk/pki/hashicorp/ca/{guid}
Retrieve details
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_GetByGuid 1 param → 200403400401
PUT
/vedsdk/pki/hashicorp/ca/{guid}
Update configuration
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Update 1 param → 200403400401
DELETE
/vedsdk/pki/hashicorp/ca/{guid}
Remove PKI configuration
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Delete 1 param → 200403400401
POST
/vedsdk/pki/hashicorp/ca/{guid}/renew
Initiate renewal or first time enrollment
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_EnrollAndProvision 1 param → 200403400401
POST
/vedsdk/pki/hashicorp/ca/
Define configuration
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Create body → 200403400401
GET
/vedsdk/pki/hashicorp/ca/
List all HashiCorp Vault PKI secrets
Venafi_Drivers_Applications_HashiCorp_HashiCorpPkiConfiguration_Get → 200403400401
Authentication Server APIs 9

The Auth REST SDK manages authorization bearer tokens. The tokens you need are based on the set of API calls that your client uses. The Auth SDK uses the VEDauth service to grant…

POST
/vedauth/authorize/device
Request a device grant
Venafi_Web_SDK_Authentication_Authorize_RequestDeviceAuth body → 200400
POST
/vedauth/authorize/oauth
Request a grant with user credentials.
Venafi_Web_SDK_Authentication_Authorize_AuthorizeOAuth body → 200400
POST
/vedauth/authorize/integrated
Request a grant via NTLM/Kerberos
Venafi_Web_SDK_Authentication_Authorize_IntegratedAuthorize body → 200400
POST
/vedauth/authorize/certificate
Request a grant via certificate
Venafi_Web_SDK_Authentication_Authorize_CertificateAuthorize body → 200400
POST
/vedauth/authorize/jwt
Request a grant via JWT
Venafi_Web_SDK_Authentication_Authorize_JwtAuthorize body → 200400
POST
/vedauth/authorize/token
Refresh a bearer/device token
Venafi_Web_SDK_Authentication_Authorize_Token body → 200403400401
GET
/vedauth/authorize/verify
Verify bearer token validity
Venafi_Web_SDK_Authentication_Authorize_VerifyToken → 200403400401
GET
/vedauth/authorize/IsAuthServer
Verify server availability
Venafi_Web_SDK_Authentication_Authorize_IsAuthServer → 200
GET
/vedauth/revoke/token
Revoke grant
Venafi_Web_SDK_Authentication_Revoke_RevokeGrant → 200202
Certificate Management APIs 22

The endpoints in this section manage TLS certificates. If you want certificates to secure SSH keys, see the SshCertificates section PKIX Parameter Set As of TPP 25.1 algorithms ar…

POST
/vedsdk/certificates/Retrieve/{vaultId}
Retrieve a certificate by vault ID
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveByVaultId 1 param body → 200400
GET
/vedsdk/certificates/Retrieve/{vaultId}
Retrieve a certificate by vault ID (GET)
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveByVaultIdGet 9 params → 200202500400
GET
/vedsdk/certificates/{guid}/PreviousVersions
Get archived certificates
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePreviousVersions 3 params → 200400
POST
/vedsdk/certificates/Validate
Validate a deployed certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateValidate body → 200400
PUT
/vedsdk/certificates/{guid}
Set or update certificate attributes
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePut 1 param body → 200400
GET
/vedsdk/certificates/{guid}
Get certificate details
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificateDetails 1 param → 200500400
DELETE
/vedsdk/certificates/{guid}
Delete a certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateDelete 1 param → 200400
POST
/vedsdk/certificates/CheckPolicy
Check policy compliance
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CheckPolicy body → 200400
POST
/vedsdk/certificates/Request
Enroll or provision a certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRequest body → 200202500400
POST
/vedsdk/certificates/Retrieve
Retrieve an issued certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieve body → 200202500400
GET
/vedsdk/certificates/Retrieve
Retrieve an issued certificate (GET)
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRetrieveGet 10 params → 200202500400
POST
/vedsdk/certificates/Renew
Renew a certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRenew body → 200202500400
POST
/vedsdk/certificates/Revoke
Revoke a certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateRevoke body → 200202500400403
GET
/vedsdk/certificates/
Search certificates
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificates 53 params → 200500400
HEAD
/vedsdk/certificates/
Get certificates count
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetCertificateCount 53 params → 200500
POST
/vedsdk/certificates/Associate
Associate an application
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateAssociate body → 200400
POST
/vedsdk/certificates/Dissociate
Dissociate an application
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateDissociate body → 200400
POST
/vedsdk/certificates/Push
Initiate provisioning
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificatePush body → 200400
POST
/vedsdk/certificates/Import
Import a certificate
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_CertificateImport body → 200400
POST
/vedsdk/certificates/Reset
Reset processing state
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_Reset body → 200400
POST
/vedsdk/certificates/Retry
Retry processing
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_Retry body → 200400
GET
/vedsdk/certificates/{guid}/ValidationResults
Retrieve certificate validation results
Venafi_WebSDK_CertificateRequest_CertificateRequestRest_GetValidationResults 1 param → 200400403500204
Discovery Management APIs 2

The Discovery interface manages certificate, device, and application information from your network.

POST
/vedsdk/discovery/Import
Import certificates
Venafi_WebSDK_CertificateRequest_CertificateDiscoveryRest_PostDiscoveryResults body → 200400
DELETE
/vedsdk/discovery/{guid}
Delete a discovery job
Venafi_WebSDK_CertificateRequest_CertificateDiscoveryRest_DiscoveryDelete 1 param → 200400
CodeSigning APIs 52

Code Sign Manager allows you to make REST API calls to manage global configurations, templates, projects, signing applications, and rights.

POST
/vedsdk/codesign/FindEnvironment
Find Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_FindEnvironment body → 200403400401
POST
/vedsdk/codesign/CreateEnvironment
Create Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateEnvironment body → 200403400401
POST
/vedsdk/codesign/DeleteEnvironment
Delete Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteEnvironment body → 200403400401
POST
/vedsdk/codesign/GetEnvironment
Get Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetEnvironment body → 200403400401
POST
/vedsdk/codesign/RenewEnvironment
Renew Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenewEnvironment body → 200403400401
POST
/vedsdk/codesign/UpdateEnvironment
Update Environment
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateEnvironment body → 200403400401
POST
/vedsdk/codesign/EnumerateProjects
Get Projects
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateProjects body → 200403400401
POST
/vedsdk/codesign/GetProject
Get Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetProject body → 200403400401
POST
/vedsdk/codesign/CreateProject
Create Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateProject body → 200403400401
POST
/vedsdk/codesign/UpdateProject
Update Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateProject body → 200403400401
POST
/vedsdk/codesign/UpdateProjectStatus
Update Project Status
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateProjectStatus body → 200403400401
POST
/vedsdk/codesign/DeleteProject
Delete Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteProject body → 200403400401
POST
/vedsdk/codesign/RenameProject
Rename Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameProject body → 200403400401
POST
/vedsdk/codesign/EnumerateTemplates
Get Templates
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateEnvironmentTemplates body → 200403400401
POST
/vedsdk/codesign/GetTemplate
Get Template
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetEnvironmentTemplate body → 200403400401
POST
/vedsdk/codesign/CreateTemplate
Create Template
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateEnvironmentTemplate body → 200403400401
POST
/vedsdk/codesign/UpdateTemplate
Update Template
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateEnvironmentTemplate body → 200403400401
POST
/vedsdk/codesign/DeleteTemplate
Delete Template
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteEnvironmentTemplate body → 200403400401
POST
/vedsdk/codesign/RenameTemplate
Rename Template
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameEnvironmentTemplate body → 200403400401
POST
/vedsdk/codesign/EnumerateApplications
Get Applications
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateApplications body → 200403400401
POST
/vedsdk/codesign/GetApplication
Get Application
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplication body → 200403400401
POST
/vedsdk/codesign/CreateApplication
Create Application
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateApplication body → 200403400401
POST
/vedsdk/codesign/UpdateApplication
Update Application
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateApplication body → 200403400401
POST
/vedsdk/codesign/DeleteApplication
Delete Application
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteApplication body → 200403400401
POST
/vedsdk/codesign/RenameApplication
Rename Application
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameApplication body → 200403400401
POST
/vedsdk/codesign/CountReferences
Get Application Reference Count
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CountReferences body → 200403400401
POST
/vedsdk/codesign/EnumerateReferences
Get Application Reference
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateReferences body → 200403400401
POST
/vedsdk/codesign/EnumerateApplicationCollections
Get All Applications Collections
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_EnumerateApplicationCollections body → 200403400401
POST
/vedsdk/codesign/GetApplicationCollection
Get Application Collections Info
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollection body → 200403400401
POST
/vedsdk/codesign/GetApplicationCollectionMemberDNs
Get Application Collection Member DNs
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollectionMemberDNs body → 200403400401
POST
/vedsdk/codesign/GetApplicationCollectionMembers
Get Members of Application Collection
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetApplicationCollectionMembers body → 200403400401
POST
/vedsdk/codesign/CreateApplicationCollection
Create Application Collection
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_CreateApplicationCollection body → 200403400401
POST
/vedsdk/codesign/UpdateApplicationCollection
Update Application Collection
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_UpdateApplicationCollection body → 200403400401
POST
/vedsdk/codesign/DeleteApplicationCollection
Delete Application Collection
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_DeleteApplicationCollection body → 200403400401
POST
/vedsdk/codesign/RenameApplicationCollection
Rename Application Collection
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RenameApplicationCollection body → 200403400401
GET
/vedsdk/codesign/GetGlobalConfiguration
Get Global Configuration
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetGlobalConfiguration → 200403400401
POST
/vedsdk/codesign/SetGlobalConfiguration
Set Global Configuration
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_SetGlobalConfiguration body → 200403400401
POST
/vedsdk/codesign/AddAdministrator
Assign Admin Rights to Trustee
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddAdminiStrator body → 200403400401
POST
/vedsdk/codesign/RemoveAdministrator
Remove Admin Rights from Trustee
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveAdministrator body → 200403400401
POST
/vedsdk/codesign/AddApplicationAdministrator
Add Application Admin Rights
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddApplicationAdminiStrator body → 200403400401
POST
/vedsdk/codesign/RemoveApplicationAdministrator
Remove Application Admin Rights
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveApplicationAdministrator body → 200403400401
POST
/vedsdk/codesign/AddProjectApprover
Add Project Approver
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_AddProjectApprover body → 200403400401
POST
/vedsdk/codesign/RemoveProjectApprover
Remove Project Approver
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RemoveProjectApprover body → 200403400401
POST
/vedsdk/codesign/GetRight
Get Caller Rights for Project
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetRight body → 200403400401
POST
/vedsdk/codesign/GetTrusteeRights
Get Trustee Rights
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetTrusteeRights body → 200403400401
POST
/vedsdk/codesign/GetObjectRights
Get Object Rights
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetObjectRights body → 200403400401
POST
/vedsdk/codesign/AddPreApproval
Add Flow Staging Information for a Pre-Approval
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_PreApprove body → 200403400401
POST
/vedsdk/codesign/RunMacro
Run Macro Info
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RunMacro body → 200403400401
POST
/vedsdk/codesign/RetrieveArchiveEntries
Retrieve Sign Archive Entries
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_RetrieveArchiveEntries body → 200403400401
POST
/vedsdk/codesign/ExportSignArchive
Exports Sign Archive Entries
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_ExportSignArchive body → 200403400401
GET
/vedsdk/codesign/ExportSignArchive
Exports Sign Archive Entries, no filtering
Venafi_WebSDK_Product_CodeSigning_CodeSigningRest_GetExportSignArchive → 200403400401
POST
/vedsdk/actions/codesign/prequalify/Create
Pre-qualify approval flow
Venafi_WebSDK_Product_CodeSigning_PreQualifiedDataRest_CreatePreQualified body → 200403400401
Credential APIs 10

The Credentials interface stores information about credentials for use in requesting certificates and other activities. Trust Protection Foundation only stores the credentials you…

POST
/vedsdk/credentials/adaptable/create
Create Adaptable credential
Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Create body → 200403400401
POST
/vedsdk/credentials/adaptable/update
Update Adaptable credential
Venafi_WebSDK_CRAdaptableRest_CRAdaptableRest_Update body → 200403400401
POST
/vedsdk/credentials/cyberark/create
Create CyberArk credential
Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Create body → 200
POST
/vedsdk/credentials/cyberark/update
Update CyberArk credential.
Venafi_WebSDK_CRCyberArkRest_CRCyberArkRest_Update body → 200
POST
/vedsdk/Credentials/create
Create a new credential
Venafi_Core_WebSDK_CredentialsRest_Create body → 200403400401
POST
/vedsdk/Credentials/delete
Delete a credential
Venafi_Core_WebSDK_CredentialsRest_Delete body → 200403400401
POST
/vedsdk/Credentials/enumerate
Enumerate all credentials
Venafi_Core_WebSDK_CredentialsRest_Enumerate body → 200403400401
POST
/vedsdk/Credentials/rename
Rename a credential
Venafi_Core_WebSDK_CredentialsRest_Rename body → 200403400401
POST
/vedsdk/Credentials/retrieve
Retrieve a credential
Venafi_Core_WebSDK_CredentialsRest_Retrieve body → 200403400401
POST
/vedsdk/Credentials/update
Update a credential
Venafi_Core_WebSDK_CredentialsRest_Update body → 200403400401
CodeSigning HSM API 10

This API allows you to request digital signing of software and manage signing, authentication, and encryption keys. This API requires the CyberArk Code Sign Manager product.

POST
/vedhsm/api/signjwt
Signs JSON Web Token
Venafi_Web_Hsm_HsmAPI_HandleSignJWT body → 200403400401
GET
/vedhsm/api/IsHsm
Verify HSM Server Info
Venafi_Web_Hsm_HsmAPI_IsAuthServer → 200403400401
POST
/vedhsm/api/sign
Sign Data
Venafi_Web_Hsm_HsmAPI_HandleSign body → 200403400401
POST
/vedhsm/api/decrypt
Decrypts Data
Venafi_Web_Hsm_HsmAPI_HandleDecrypt body → 200403400401
POST
/vedhsm/api/derive
Derives a Key
Venafi_Web_Hsm_HsmAPI_HandleDerive body → 200403400401
POST
/vedhsm/api/getgpgpublickey
Get GPG public key
Venafi_Web_Hsm_HsmAPI_HandleGetGpgPublicKey body → 200403400401
POST
/vedhsm/api/storeobject
Stores a key within an environment
Venafi_Web_Hsm_HsmAPI_HandleStoreObject body → 200403400401
POST
/vedhsm/api/getchain
Get Certificate Chain
Venafi_Web_Hsm_HsmAPI_HandleGetChain body → 200403400401
POST
/vedhsm/api/getobjects
Get Objects
Venafi_Web_Hsm_HsmAPI_HandleGetAll body → 200403400401
POST
/vedhsm/api/csctelemetry
Code Sign Client Telemetry
Venafi_Web_Hsm_HsmAPI_HandleTelemetry body → 200403400401
System Status APIs 9

The SystemStatus interface provides status and upgrade information about Trust Protection Foundation engines. This information also appears in the UI. Engine Upgrade Status Engine…

GET
/vedscim/{owner}/available
Get provider-specific SCIM endpoint status
Venafi_Scim_Server_Endpoints_GetCheckAvailable 1 param → 202404
GET
/vedscim/available
Get SCIM Server endpoint status
Venafi_Scim_Server_Endpoints_GetCheckGlobalAvailable → 202
GET
/vedsdk/SystemStatus/
Get all engines
Venafi_Core_WebSDK_SystemStatusRest_Get → 200
GET
/vedsdk/SystemStatus/Version
Get engine schema version
Venafi_Core_WebSDK_SystemStatusRest_GetVersion → 200
GET
/vedsdk/SystemStatus/Upgrade/Status
Get upgrade status
Venafi_Core_WebSDK_SystemStatusRest_IsAnUpgradeRunning → 200403500
GET
/vedsdk/SystemStatus/Upgrade/Summary
Get upgrade summary
Venafi_Core_WebSDK_SystemStatusRest_UpgradeSummary → 200403500
GET
/vedsdk/SystemStatus/Upgrade/Engine
Get the upgrade status of one engine
Venafi_Core_WebSDK_SystemStatusRest_Engine 3 params → 200403400401
GET
/vedsdk/SystemStatus/Upgrade/Engines
Get all engine upgrade statuses
Venafi_Core_WebSDK_SystemStatusRest_Engines 1 param → 200403400401
GET
/vedsdk/SystemStatus/Upgrade/History
Get upgrade history
Venafi_Core_WebSDK_SystemStatusRest_History → 200403400401
Client Management APIs 4

OSName Definitions AIX Android BlackBerry BSD HPux iOS Linux MacOS Other Solaris Unknown Windows zOS ClientType Definitions |ClientType|Description| |---|---| |VenafiAgent|Return…

GET
/vedsdk/client/
Search client records
ClientWebSDK_ClientSdkService_Get 15 params → 200204400
GET
/vedsdk/client/details/
Search client records (details)
ClientWebSDK_ClientSdkService_GetDetails 1 param → 200204400
POST
/vedsdk/client/delete
Delete client records
ClientWebSDK_ClientSdkService_Delete body → 200
GET
/vedsdk/client/work/
Get own work
ClientWebSDK_ClientSdkService_GetUserWork 1 param → 200204400
AlgorithmSelector APIs 10

The AlgorithmSelector interface provides the ability to retrieve and configure allowed Key Algorithms for policy, key and certificate objects

POST
/vedsdk/algorithmselector/get
Get the algorithm configured for an object
Venafi_Core_WebSDK_AlgorithmSelectorRest_Get body → 200403400401
POST
/vedsdk/algorithmselector/commit
Set the algorithm configured for an object
Venafi_Core_WebSDK_AlgorithmSelectorRest_Commit body → 200403400401
POST
/vedsdk/algorithmselector/find
Find algorithm selectors for a specific security strength
Venafi_Core_WebSDK_AlgorithmSelectorRest_Find body → 200403400401
POST
/vedsdk/algorithmselector/getpolicy
Get the allowed algorithms for a container
Venafi_Core_WebSDK_AlgorithmSelectorRest_GetPolicy body → 200403400401
POST
/vedsdk/algorithmselector/commitpolicy
Set the allowed algorithms for a container
Venafi_Core_WebSDK_AlgorithmSelectorRest_CommitPolicy body → 200403400401
POST
/vedsdk/algorithmselector/getselector
Get details about an algorithm
Venafi_Core_WebSDK_AlgorithmSelectorRest_GetOid body → 200403400401
POST
/vedsdk/algorithmselector/getallselectors
Get all algorithms
Venafi_Core_WebSDK_AlgorithmSelectorRest_GetAllAlgorithms body → 200403400401
POST
/vedsdk/algorithmselector/getallowedalgorithms
Get allowed algorithms for an object
Venafi_Core_WebSDK_AlgorithmSelectorRest_GetAllowedAlgorithms body → 200403400401
POST
/vedsdk/algorithmselector/getglobalalgorithms
Get the globally allowed algorithms
Venafi_Core_WebSDK_AlgorithmSelectorRest_GetGlobalAlgorithms body → 200403400401
POST
/vedsdk/algorithmselector/setglobalalgorithms
Set the globally allowed algorithms
Venafi_Core_WebSDK_AlgorithmSelectorRest_SetGlobalAlgorithms body → 200403400401
Flow APIs 8

The Flow API manages the sequence of tasks. If one of the tasks is has an 'approval required', Flow Tickets manages that approval.

POST
/vedsdk/flow/tickets/enumerate
Enumerate pending tickets.
Venafi_Core_WebSDK_FlowTicketRest_EnumerateTickets body → 200403400401
POST
/vedsdk/flow/tickets/enumerateapproved
Enumerate approved and still in use tickets.
Venafi_Core_WebSDK_FlowTicketRest_EnumerateApproved body → 200403400401
POST
/vedsdk/flow/tickets/approve
Approve one or more pending tickets.
Venafi_Core_WebSDK_FlowTicketRest_Approve body → 200403400401
POST
/vedsdk/flow/tickets/reject
Reject one or more pending tickets.
Venafi_Core_WebSDK_FlowTicketRest_Reject body → 200403400401
POST
/vedsdk/flow/tickets/count
Count pending tickets.
Venafi_Core_WebSDK_FlowTicketRest_Count body → 200403400401
POST
/vedsdk/flow/tickets/countapproved
Count approved tickets.
Venafi_Core_WebSDK_FlowTicketRest_CountApproved body → 200403400401
POST
/vedsdk/flow/tickets/load
Load a single ticket
Venafi_Core_WebSDK_FlowTicketRest_LoadSingle body → 200403400401
POST
/vedsdk/flow/tickets/update
Update existing approval
Venafi_Core_WebSDK_FlowTicketRest_UpdateExisting body → 200403400401
Platform APIs 6

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 the standby feature is en…

GET
/vedsdk/serverstatus/idle
Check if idle
Venafi_Core_WebSDK_ServerStatusRest_GetStandby → 200404
GET
/vedsdk/serverstatus/active
Check if active
Venafi_Core_WebSDK_ServerStatusRest_GetActive → 200404
POST
/vedsdk/BusStatus/getstatus
Request bus participant status
Venafi_Core_WebSDK_BusStatusRest_GetStatus body → 200403400401
POST
/vedsdk/BusStatus/getmeshdnsname
Get mesh partner DNS name
Venafi_Core_WebSDK_BusStatusRest_GetMeshDnsName body → 200403400401
POST
/vedsdk/BusStatus/setmeshdnsname
Set mesh partner DNS name
Venafi_Core_WebSDK_BusStatusRest_SetMeshDnsName body → 200403400401
POST
/vedsdk/platform/delete
Delete an engine
Venafi_Platform_WebSDK_PlatformRest_DeletePlatform body → 200403400401
User Preference APIs 3

The Preference APIs allow to manages the caller's user preferences

GET
/vedsdk/preferences/
Get user preferences
Venafi_Core_WebSDK_PreferenceRest_Get 3 params → 200401400
POST
/vedsdk/preferences/
Add user preference
Venafi_Core_WebSDK_PreferenceRest_Add body → 201401400
DELETE
/vedsdk/preferences/
Clear user preference
Venafi_Core_WebSDK_PreferenceRest_Clear 3 params → 200401400
Recycle Bin APIs 10

The RecycleBin interface allows you to manage old or recently deleted data.

POST
/vedsdk/recyclebin/getcontents
Retrieve deleted items
Venafi_Core_WebSDK_RecycleBinRest_GetContents body → 200403400401
POST
/vedsdk/recyclebin/getitem
Retrieve deleted item
Venafi_Core_WebSDK_RecycleBinRest_GetRecycledItem body → 200403400401
POST
/vedsdk/recyclebin/getitemdetails
Retrieve deleted item details
Venafi_Core_WebSDK_RecycleBinRest_GetRecycledItemDetails body → 200403400401
POST
/vedsdk/recyclebin/restore
Restore deleted item
Venafi_Core_WebSDK_RecycleBinRest_Restore body → 200403400401
POST
/vedsdk/recyclebin/purge
Purge deleted item
Venafi_Core_WebSDK_RecycleBinRest_Purge body → 200403400401
POST
/vedsdk/recyclebin/empty
Purge all items
Venafi_Core_WebSDK_RecycleBinRest_Empty body → 200403400401
POST
/vedsdk/recyclebin/setconfiguration
Set recyclebin configuration
Venafi_Core_WebSDK_RecycleBinRest_SetConfiguration body → 200403400401
POST
/vedsdk/recyclebin/getconfiguration
Get recyclebin configuration
Venafi_Core_WebSDK_RecycleBinRest_GetConfiguration body → 200403400401
POST
/vedsdk/recyclebin/purgetask
Start/stop background purge
Venafi_Core_WebSDK_RecycleBinRest_PurgeTask body → 200403400401
POST
/vedsdk/recyclebin/deletiontask
Start/stop deletion task
Venafi_Core_WebSDK_RecycleBinRest_DeletionTask body → 200403400401
Access Management APIs 32

The endpoints in this section allow you to manage your OAuth environment. Using endpoints described in this section, you can configure your global OAuth properties, assign roles t…

POST
/vedsdk/oauth/grantrole
Assign a role
Venafi_Core_WebSDK_OAuthRest_GrantRole body → 200
POST
/vedsdk/oauth/revokerole
Remove a role
Venafi_Core_WebSDK_OAuthRest_RevokeRole body → 200403400401
POST
/vedsdk/oauth/listroles
Get assigned roles
Venafi_Core_WebSDK_OAuthRest_ListRoles body → 200403400401
POST
/vedsdk/oauth/getrole
Get own role
Venafi_Core_WebSDK_OAuthRest_GetRole body → 200403400401
POST
/vedsdk/oauth/getconfiguration
Get configuration
Venafi_Core_WebSDK_OAuthRest_GetConfiguration body → 200403400401
POST
/vedsdk/oauth/setconfiguration
Set configuration
Venafi_Core_WebSDK_OAuthRest_SetConfiguration body → 200403400401
POST
/vedsdk/oauth/createapplication
Create an application
Venafi_Core_WebSDK_OAuthRest_CreateApplication body → 200403400401
POST
/vedsdk/oauth/enumerateapplications
Enumerate all applications
Venafi_Core_WebSDK_OAuthRest_EnumerateApplications body → 200403400401
POST
/vedsdk/oauth/getapplications
Search applications
Venafi_Core_WebSDK_OAuthRest_GetApplications body → 200403400401
POST
/vedsdk/oauth/getapplication
Get an application
Venafi_Core_WebSDK_OAuthRest_GetApplication body → 200403400401
POST
/vedsdk/oauth/updateapplication
Update an application
Venafi_Core_WebSDK_OAuthRest_UpdateApplication body → 200403400401
POST
/vedsdk/oauth/deleteapplication
Delete an application
Venafi_Core_WebSDK_OAuthRest_DeleteApplication body → 200403400401
POST
/vedsdk/oauth/getscopes
Get all scopes
Venafi_Core_WebSDK_OAuthRest_GetScopes body → 200403400401
POST
/vedsdk/oauth/getgrants
Get grants issued to an identity
Venafi_Core_WebSDK_OAuthRest_GetGrants body → 200403400401
POST
/vedsdk/oauth/enumerategrants
Enumerate all application grants
Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateGrants body → 200403400401
POST
/vedsdk/oauth/revokegrants
Revoke grants
Venafi_Core_WebSDK_OAuthRest_RevokeGrants body → 200403400401
POST
/vedsdk/oauth/createrule
Create a rule
Venafi_Core_WebSDK_OAuthRest_CreateRule body → 200403400401
POST
/vedsdk/oauth/getrules
Search rules
Venafi_Core_WebSDK_OAuthRest_GetRules body → 200403400401
POST
/vedsdk/oauth/enumeraterules
Enumerate all rules
Venafi_Core_WebSDK_OAuthRest_GetAndEnumerateRules body → 200403400401
POST
/vedsdk/oauth/updaterule
Update a rule
Venafi_Core_WebSDK_OAuthRest_UpdateRule body → 200403400401
POST
/vedsdk/oauth/deleterule
Delete a rule
Venafi_Core_WebSDK_OAuthRest_DeleteRule body → 200403400401
POST
/vedsdk/oauth/deleterules
Deletes rules
Venafi_Core_WebSDK_OAuthRest_DeleteRules body → 200403400401
POST
/vedsdk/oauth/grantcount
Get grant count
Venafi_Core_WebSDK_OAuthRest_GrantCount body → 200403400401
POST
/vedsdk/oauth/usercount
Get user count
Venafi_Core_WebSDK_OAuthRest_UserCount body → 200403400401
POST
/vedsdk/oauth/createjwtmapping
Create JWT mapping
Venafi_Core_WebSDK_OAuthRest_CreateJwtMapping body → 200403400401
POST
/vedsdk/oauth/enumeratejwtmappings
Enumerate JWT mappings
Venafi_Core_WebSDK_OAuthRest_EnumerateJwtMappings body → 200403400401
POST
/vedsdk/oauth/getjwtmappings
Search JWT mappings
Venafi_Core_WebSDK_OAuthRest_GetJwtMappings body → 200403400401
POST
/vedsdk/oauth/getjwtmapping
Get JWT mapping
Venafi_Core_WebSDK_OAuthRest_GetJwtMapping body → 200403400401
POST
/vedsdk/oauth/updatejwtmapping
Update JWT mapping
Venafi_Core_WebSDK_OAuthRest_UpdateJwtMapping body → 200403400401
POST
/vedsdk/oauth/deletejwtmapping
Delete JWT mapping
Venafi_Core_WebSDK_OAuthRest_DeleteJwtMapping body → 200403400401
POST
/vedsdk/rights/grantsystemrole
Grant a system role to a user or group
Venafi_Core_WebSDK_RightsRest_GrantSystemRole body → 200403400401
POST
/vedsdk/rights/revokesystemrole
Revoke a system role from a user or group
Venafi_Core_WebSDK_RightsRest_RevokeSystemRole body → 200403400401
Statistics APIs 9

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.

POST
/vedsdk/stats/createcounter
Create a counter
Venafi_Core_WebSDK_StatsRest_CreateCounter body → 200403400401
POST
/vedsdk/stats/deletecounter
Delete a counter
Venafi_Core_WebSDK_StatsRest_DeleteCounter body → 200403400401
POST
/vedsdk/stats/renamecounter
Rename a counter
Venafi_Core_WebSDK_StatsRest_RenameCounter body → 200403400401
POST
/vedsdk/stats/updatecounter
Update a counter
Venafi_Core_WebSDK_StatsRest_UpdateCounter body → 200403400401
POST
/vedsdk/stats/getcounter
Get a counter
Venafi_Core_WebSDK_StatsRest_GetCounter body → 200403400401
POST
/vedsdk/stats/getcounters
Get all counters
Venafi_Core_WebSDK_StatsRest_GetCounters body → 200403400401
POST
/vedsdk/stats/countercontainers
Get containers
Venafi_Core_WebSDK_StatsRest_GetCounterContainers body → 200403400401
POST
/vedsdk/stats/query
Get values
Venafi_Core_WebSDK_StatsRest_Query body → 200403400401
POST
/vedsdk/stats/querytags
Search tags
Venafi_Core_WebSDK_StatsRest_QueryTags body → 200403400401
Processing Engines APIs 7

The ProcessingEngines interface assigns and controls how Platforms engines manage information in Policy folders. These features provide a means for load balancing certificate mana…

GET
/vedsdk/processingengines/
Get all processing engines
Venafi_Core_WebSDK_ManagementPartitionRest_GetEngines → 200403400401
GET
/vedsdk/processingengines/folder/{folderGuid}
Get restrictions for a folder
Venafi_Core_WebSDK_ManagementPartitionRest_GetFolderRestrictions 1 param → 200403400401
PUT
/vedsdk/processingengines/folder/{folderGuid}
Update restriction
Venafi_Core_WebSDK_ManagementPartitionRest_SetFolderRestrictions 2 params body → 200403400401
DELETE
/vedsdk/processingengines/folder/{folderGuid}
Clear all restrictions on a folder
Venafi_Core_WebSDK_ManagementPartitionRest_Clear 1 param → 200403400401
GET
/vedsdk/processingengines/engine/{engineGuid}
Get restrictions for an engine
Venafi_Core_WebSDK_ManagementPartitionRest_GetEngineRestrictions 1 param → 200403400401
POST
/vedsdk/processingengines/engine/{engineGuid}
Add a new restriction
Venafi_Core_WebSDK_ManagementPartitionRest_AddEngineRestrictions 1 param body → 200403400401
DELETE
/vedsdk/processingengines/folder/{folderGuid}/{engineGuid}
Remove one engine from restriction on a folder
Venafi_Core_WebSDK_ManagementPartitionRest_Remove 2 params → 200403400401
Permission APIs 19

The Permissions interface enables the management and querying of permissions within CyberArk Trust Protection Foundation™. Permissions grant principals (users and groups) privileg…

POST
/vedsdk/permissions/getprincipals
Get trustees
Venafi_Core_WebSDK_PermissionsRest_GetPrincipals body → 200403400401
POST
/vedsdk/permissions/getpermissions
Get assigned permissions
Venafi_Core_WebSDK_PermissionsRest_GetPermissions body → 200403400401
POST
/vedsdk/permissions/geteffectivepermissions
Get effective permissions
Venafi_Core_WebSDK_PermissionsRest_GetEffectivePermissions body → 200403400401
POST
/vedsdk/permissions/grantpermissions
Grant permissions
Venafi_Core_WebSDK_PermissionsRest_GrantPermissions body → 200403400401
POST
/vedsdk/permissions/revokepermissions
Revoke permissions
Venafi_Core_WebSDK_PermissionsRest_RevokePermissions body → 200403400401
POST
/vedsdk/permissions/replacepermissions
Update permissions
Venafi_Core_WebSDK_PermissionsRest_ReplacePermissions body → 200403400401
GET
/vedsdk/permissions/refresh
Refresh permissions
Venafi_Core_WebSDK_PermissionsRest_Refresh → 200403400401
GET
/vedsdk/permissions/object/{guid}deprecated
Gets object trustees
Venafi_Core_WebSDK_PermissionsRest_GetPrincipalsForObject 1 param → 200
GET
/vedsdk/permissions/object/{guid}/local/{identity}deprecated
Get assigned permissions of a local identity
Venafi_Core_WebSDK_PermissionsRest_GetLocalPermissions 2 params → 200
GET
/vedsdk/permissions/object/{guid}/local/{identity}/effectivedeprecated
Get effective permissions of local identity
Venafi_Core_WebSDK_PermissionsRest_GetLocalEffectivePermissions 2 params → 200
GET
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Get assigned permissions of an identity
Venafi_Core_WebSDK_PermissionsRest_GetExtProviderPermissions 4 params → 200
DELETE
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Delete permissions
Venafi_Core_WebSDK_PermissionsRest_DeleteExtProviderPermission 4 params → 200
POST
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Add permissions
Venafi_Core_WebSDK_PermissionsRest_AddExtProviderPermission 4 params → 200
PUT
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}deprecated
Update permissions
Venafi_Core_WebSDK_PermissionsRest_UpdateExtProviderPermission 4 params → 200
GET
/vedsdk/permissions/object/{guid}/{prefix}/{identity}/{principal}/effectivedeprecated
Get effective permissions of an identity
Venafi_Core_WebSDK_PermissionsRest_GetExtProviderEffectivePermissions 4 params → 200
GET
/vedsdk/permissions/object/{guid}/myeffectivedeprecated
Gets the effective permissions of the session's user for the given object.
Venafi_Core_WebSDK_PermissionsRest_GetMyEffectivePermissions 1 param → 200
DELETE
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Delete permissions
Venafi_Core_WebSDK_PermissionsRest_DeleteLocalPermission 2 params → 200
POST
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Add permissions
Venafi_Core_WebSDK_PermissionsRest_AddLocalPermission 2 params → 200
PUT
/vedsdk/permissions/object/{guid}/local/{principal}deprecated
Update permissions
Venafi_Core_WebSDK_PermissionsRest_UpdateLocalPermission 2 params → 200
Configuration APIs 43

Introduction The Config interface manages objects, attributes, and policy values. API responses include a Result value that describes the result of the API call. If an operation f…

POST
/vedsdk/config/enumerate
Search objects
Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsFilteredRecursive body → 200403400401
POST
/vedsdk/config/enumerateall
Enumerate objects
Venafi_Core_WebSDK_ConfigRest_EnumerateAllObjects body → 200403400401
POST
/vedsdk/config/enumeratepolicies
Enumerate policies
Venafi_Core_WebSDK_ConfigRest_EnumeratePolicies body → 200403400401
POST
/vedsdk/config/enumerateobjectsderivedfrom
Enumerate derived objects
Venafi_Core_WebSDK_ConfigRest_EnumerateObjectsDerivedFrom body → 200403400401
POST
/vedsdk/config/create
Create an object
Venafi_Core_WebSDK_ConfigRest_CreateObject body → 200403400401
POST
/vedsdk/config/delete
Delete an object
Venafi_Core_WebSDK_ConfigRest_DeleteObjectRecursive body → 200403400401
GET
/vedsdk/config/defaultdn
Gets the default DN
Venafi_Core_WebSDK_ConfigRest_DefaultDN → 200403400401
POST
/vedsdk/config/find
Search an object by attribute
Venafi_Core_WebSDK_ConfigRest_FindByAttribute body → 200403400401
POST
/vedsdk/config/readall
Read all attributes
Venafi_Core_WebSDK_ConfigRest_ReadAllAttributes body → 200403400401
POST
/vedsdk/config/findcontainers
Search containers
Venafi_Core_WebSDK_ConfigRest_FindContainer body → 200403400401
POST
/vedsdk/config/findobjectsofclass
Search objects of class
Venafi_Core_WebSDK_ConfigRest_FindObjectsOfClass body → 200403400401
POST
/vedsdk/config/findpolicy
Search policies
Venafi_Core_WebSDK_ConfigRest_FindPolicy body → 200403400401
POST
/vedsdk/config/gethighestrevision
Get highest container revision
Venafi_Core_WebSDK_ConfigRest_GetHighestRevision body → 200403400401
POST
/vedsdk/config/getrevision
Get object revision
Venafi_Core_WebSDK_ConfigRest_GetRevision body → 200403400401
POST
/vedsdk/config/getobjecttrustees
Get trustees of object
Venafi_Core_WebSDK_ConfigRest_GetObjectTrustees body → 200403400401
POST
/vedsdk/config/guidtodn
Convert GUID to DN
Venafi_Core_WebSDK_ConfigRest_GUIDtoDN body → 200403400401
POST
/vedsdk/config/isvalid
Check if object exists
Venafi_Core_WebSDK_ConfigRest_IsValid body → 200403400401
POST
/vedsdk/config/mutateobject
Change object class
Venafi_Core_WebSDK_ConfigRest_MutateObject body → 200403400401
POST
/vedsdk/config/containableclasses
Enumerate container classes
Venafi_Core_WebSDK_ConfigRest_ContainableClasses body → 200403400401
POST
/vedsdk/config/dntoguid
Convert DN to GUID
Venafi_Core_WebSDK_ConfigRest_DNToGUID body → 200403400401
POST
/vedsdk/config/idinfo
Convert ID to DN
Venafi_Core_WebSDK_ConfigRest_IDToDN body → 200403400401
POST
/vedsdk/config/renameobject
Rename an object
Venafi_Core_WebSDK_ConfigRest_RenameObject body → 200403400401
POST
/vedsdk/config/clearattribute
Remove an attribute
Venafi_Core_WebSDK_ConfigRest_ClearAttribute body → 200403400401
POST
/vedsdk/config/clearpolicyattribute
Remove a policy attribute
Venafi_Core_WebSDK_ConfigRest_ClearPolicyAttribute body → 200403400401
POST
/vedsdk/config/read
Read an attribute
Venafi_Core_WebSDK_ConfigRest_Read body → 200403400401
POST
/vedsdk/config/countobjects
Return number of objects
Venafi_Core_WebSDK_ConfigRest_CountObjects body → 200403400401
POST
/vedsdk/config/readdn
Read a DN attribute
Venafi_Core_WebSDK_ConfigRest_ReadDN body → 200403400401
POST
/vedsdk/config/readdnreferences
Find all objects referencing a DN
Venafi_Core_WebSDK_ConfigRest_ReadDNReferences body → 200403400401
POST
/vedsdk/config/readeffectivepolicy
Read effective attribute
Venafi_Core_WebSDK_ConfigRest_ReadEffectivePolicy body → 200403400401
POST
/vedsdk/config/readpolicy
Read policy attribute
Venafi_Core_WebSDK_ConfigRest_ReadPolicy body → 200403400401
POST
/vedsdk/config/addvalue
Add attribute value
Venafi_Core_WebSDK_ConfigRest_AddValue body → 200403400401
POST
/vedsdk/config/adddnvalue
Add DN attribute value
Venafi_Core_WebSDK_ConfigRest_AddDNValue body → 200403400401
POST
/vedsdk/config/addpolicyvalue
Add policy attribute value
Venafi_Core_WebSDK_ConfigRest_AddPolicyValue body → 200403400401
POST
/vedsdk/config/removevalue
Remove attribute value
Venafi_Core_WebSDK_ConfigRest_RemoveValue body → 200403400401
POST
/vedsdk/config/removednvalue
Remove DN attribute value
Venafi_Core_WebSDK_ConfigRest_RemoveDNValue body → 200403400401
POST
/vedsdk/config/removepolicyvalue
Remove policy attribute value
Venafi_Core_WebSDK_ConfigRest_RemovePolicyValue body → 200403400401
POST
/vedsdk/config/write
Write attributes
Venafi_Core_WebSDK_ConfigRest_Write body → 200403400401
POST
/vedsdk/config/writedn
Write DN attributes
Venafi_Core_WebSDK_ConfigRest_WriteDN body → 200403400401
POST
/vedsdk/config/writepolicy
Write policy attributes
Venafi_Core_WebSDK_ConfigRest_WritePolicy body → 200403400401
POST
/vedsdk/configschema/classes
Get class definitions
Venafi_Core_WebSDK_ConfigSchemaRest_Classes body → 200403400401
POST
/vedsdk/configschema/class
Get a class definition
Venafi_Core_WebSDK_ConfigSchemaRest_Class body → 200403400401
POST
/vedsdk/configschema/attributes
Get attributes
Venafi_Core_WebSDK_ConfigSchemaRest_Attribues body → 200403400401
POST
/vedsdk/configschema/attribute
Get an attribute
Venafi_Core_WebSDK_ConfigSchemaRest_Attribute body → 200403400401
SecretStore APIs 22

SecretStore APIs

POST
/vedsdk/X509CertificateStore/add
Add an X509 certificate
Venafi_Core_WebSDK_X509CertificateStoreRest_Add body → 200400401500
POST
/vedsdk/X509CertificateStore/lookup
Lookup X509 certificates
Venafi_Core_WebSDK_X509CertificateStoreRest_Lookup body → 200400401500
POST
/vedsdk/X509CertificateStore/lookupexpiring
Lookup expiring X509 certificates
Venafi_Core_WebSDK_X509CertificateStoreRest_LookupExpiring body → 200400401500
POST
/vedsdk/X509CertificateStore/remove
Remove an X509 certificate
Venafi_Core_WebSDK_X509CertificateStoreRest_Remove body → 200400401500
POST
/vedsdk/X509CertificateStore/retrieve
Retrieve an X509 certificate
Venafi_Core_WebSDK_X509CertificateStoreRest_Retrieve body → 200400401500
POST
/vedsdk/secretstore/add
Add a secret
Venafi_Core_WebSDK_SecretStoreRest_Add body → 200403400401
GET
/vedsdk/secretstore/availablenamespaces
List available namespace
Venafi_Core_WebSDK_SecretStoreRest_AvailableNamespaces → 200403400401
POST
/vedsdk/secretstore/associate
Add an association
Venafi_Core_WebSDK_SecretStoreRest_Associate body → 200403400401
POST
/vedsdk/secretstore/dissociate
Remove an association
Venafi_Core_WebSDK_SecretStoreRest_Dissociate body → 200403400401
GET
/vedsdk/secretstore/encryptionkeysinuse
Get encryption keys in use
Venafi_Core_WebSDK_SecretStoreRest_EncryptionKeysInUse → 200403400401
GET
/vedsdk/secretstore/lookup
Search a secret
Venafi_Core_WebSDK_SecretStoreRest_Lookup → 200403400401
POST
/vedsdk/secretstore/lookupbyvaulttype
Search by vault type
Venafi_Core_WebSDK_SecretStoreRest_LookupByVaultType body → 200403400401
POST
/vedsdk/secretstore/lookupbyassociation
Search by association
Venafi_Core_WebSDK_SecretStoreRest_LookupAssociation body → 200403400401
POST
/vedsdk/secretstore/lookupassociationbyvaultid
Lookup association by vault id
Venafi_Core_WebSDK_SecretStoreRest_LookupAssociationByVaultID body → 200403400401
POST
/vedsdk/secretstore/lookupallassociationsbyvaultid
Get all associations by vault id
Venafi_Core_WebSDK_SecretStoreRest_LookupAllAssociationsByVaultID body → 200403400401
POST
/vedsdk/secretstore/mutate
Change secret type
Venafi_Core_WebSDK_SecretStoreRest_Mutate body → 200403400401
POST
/vedsdk/secretstore/lookupbyowner
Search by owner
Venafi_Core_WebSDK_SecretStoreRest_LookupByOwner body → 200403400401
POST
/vedsdk/secretstore/owneradd
Add an owner
Venafi_Core_WebSDK_SecretStoreRest_OwnerAdd body → 200403400401
POST
/vedsdk/secretstore/ownerdelete
Delete an owner
Venafi_Core_WebSDK_SecretStoreRest_OwnerDelete body → 200403400401
POST
/vedsdk/secretstore/ownerlookup
Get owners of a secret
Venafi_Core_WebSDK_SecretStoreRest_Ownerlookup body → 200403400401
POST
/vedsdk/secretstore/retrieve
Retrieve a secret
Venafi_Core_WebSDK_SecretStoreRest_Retrieve body → 200403400401
GET
/vedsdk/secretstore/rotatekey/{vaultid}
Rotate a key
Venafi_Core_WebSDK_SecretStoreRest_RotateKey 2 params → 200403400401
Encryption APIs 2

The Crypto interface provides limited access to the cryptography configuration. Trust Protection Foundation installs with two encryption keys, the default Trust Protection Foundat…

GET
/vedsdk/crypto/availablekeys
List available keys
Venafi_Core_WebSDK_CryptoRest_AvailableKeys → 200403400401
GET
/vedsdk/crypto/defaultkey
Get default key
Venafi_Core_WebSDK_CryptoRest_DefaultKey → 200403400401
Identity APIs 13

The Identity interface manages users and group access. The Web SDK supports the following identity providers for viewing individuals and groups of users: |Provider|Requirements| |…

POST
/vedsdk/identity/browse
Search Identity Entries
Venafi_Core_WebSDK_IdentityRest_Browse body → 200403400401
POST
/vedsdk/identity/getassociatedentries
Get Associated Identity Entries
Venafi_Core_WebSDK_IdentityRest_GetAssociatedEntries body → 200403400401
POST
/vedsdk/identity/getmembers
Get Group Members
Venafi_Core_WebSDK_IdentityRest_GetMembers body → 200403400401
POST
/vedsdk/identity/getmemberships
Get Groups
Venafi_Core_WebSDK_IdentityRest_GetMemberships body → 200403400401
POST
/vedsdk/identity/readattribute
Read Attribute
Venafi_Core_WebSDK_IdentityRest_ReadAttribute body → 200403400401
POST
/vedsdk/identity/validate
Verify Identity Entry
Venafi_Core_WebSDK_IdentityRest_Validate body → 200403400401
GET
/vedsdk/identity/self
Who Am I
Venafi_Core_WebSDK_IdentityRest_Self → 200403400401
POST
/vedsdk/identity/SetPassword
Change Password
Venafi_Core_WebSDK_IdentityRest_SetIdentityPassword body → 200403400401
POST
/vedsdk/identity/addgroup
Add Group
Venafi_Core_WebSDK_IdentityRest_AddGroup body → 200403400401
PUT
/vedsdk/identity/renamegroup
Rename Group
Venafi_Core_WebSDK_IdentityRest_RenameGroup body → 200403400401
DELETE
/vedsdk/identity/group/{prefix}/{principal}
Delete Group
Venafi_Core_WebSDK_IdentityRest_DeleteGroup 2 params → 200400
PUT
/vedsdk/identity/addgroupmembers
Add Group Members
Venafi_Core_WebSDK_IdentityRest_AddGroupMembers body → 200403400401
PUT
/vedsdk/identity/removegroupmembers
Remove Group Members
Venafi_Core_WebSDK_IdentityRest_RemoveGroupMembers body → 200403400401
Metadata APIs 17

The Metadata interface manages Custom Fields for objects that appear in the following places of the UI: Certificates Devices Code Signing Projects Code Signing Environments Metada…

POST
/vedsdk/metadata/defineitem
Create a Custom Field
Venafi_Core_WebSDK_MetadataRest_DefineItem body → 200403400401
POST
/vedsdk/metadata/updateitem
Update a Custom Field
Venafi_Core_WebSDK_MetadataRest_UpdateItem body → 200403400401
POST
/vedsdk/metadata/undefineitem
Delete a Custom Field
Venafi_Core_WebSDK_MetadataRest_UndefineItem body → 200403400401
GET
/vedsdk/metadata/items
Get all Custom Fields
Venafi_Core_WebSDK_MetadataRest_GetAllItems → 200403400401
POST
/vedsdk/metadata/finditem
Find a Custom Field
Venafi_Core_WebSDK_MetadataRest_FindItem body → 200403400401
POST
/vedsdk/metadata/loaditem
Get Custom Field definition
Venafi_Core_WebSDK_MetadataRest_LoadItem body → 200403400401
POST
/vedsdk/metadata/loaditemguid
Get Custom Field GUID
Venafi_Core_WebSDK_MetadataRest_LoadItemGuid body → 200403400401
POST
/vedsdk/metadata/get
Read values
Venafi_Core_WebSDK_MetadataRest_Get body → 200403400401
POST
/vedsdk/metadata/readeffectivevalues
Read effective value
Venafi_Core_WebSDK_MetadataRest_ReadEffective body → 200403400401
POST
/vedsdk/metadata/readpolicy
Read policy value
Venafi_Core_WebSDK_MetadataRest_ReadPolicy body → 200403400401
POST
/vedsdk/metadata/set
Write value
Venafi_Core_WebSDK_MetadataRest_Set body → 200403400401
POST
/vedsdk/metadata/setpolicy
Write policy value
Venafi_Core_WebSDK_MetadataRest_SetPolicy body → 200403400401
POST
/vedsdk/metadata/find
Search objects
Venafi_Core_WebSDK_MetadataRest_Find body → 200403400401
POST
/vedsdk/metadata/getitems
Get applicable Custom Fields
Venafi_Core_WebSDK_MetadataRest_GetItems body → 200403400401
POST
/vedsdk/metadata/getitemguids
Get applicable Custom Field GUIDs
Venafi_Core_WebSDK_MetadataRest_GetItemGuids body → 200403400401
POST
/vedsdk/metadata/getpolicyitems
Get allowed Custom Fields
Venafi_Core_WebSDK_MetadataRest_GetPolicyItems body → 200403400401
POST
/vedsdk/metadata/getitemsforclass
Get Custom Fields for class
Venafi_Core_WebSDK_MetadataRest_GetItemsForClass body → 200403400401
Legacy Workflow APIs 7

The Workflow/Ticket interface manages certificates in an automated workflow. Trust Protection Foundation engines rely upon workflow object settings and their assignment to folders…

POST
/vedsdk/workflow/ticket/create
Create a workflow ticket
Venafi_Core_WebSDK_WorkflowTicketRest_TicketCreate body → 200400401500
POST
/vedsdk/workflow/ticket/delete
Remove a workflow ticket
Venafi_Core_WebSDK_WorkflowTicketRest_TicketDelete body → 200400401500
POST
/vedsdk/workflow/ticket/details
Get workflow ticket details
Venafi_Core_WebSDK_WorkflowTicketRest_TicketDetails body → 200400401500
POST
/vedsdk/workflow/ticket/enumerate
Enumerate workflow tickets
Venafi_Core_WebSDK_WorkflowTicketRest_TicketEnumerate body → 200400401500
POST
/vedsdk/workflow/ticket/exists
Verify workflow ticket exists
Venafi_Core_WebSDK_WorkflowTicketRest_TicketExists body → 200400401500
POST
/vedsdk/workflow/ticket/status
Get workflow ticket status
Venafi_Core_WebSDK_WorkflowTicketRest_TicketStatus body → 200400401500
POST
/vedsdk/workflow/ticket/updatestatus
Update workflow ticket status
Venafi_Core_WebSDK_WorkflowTicketRest_TicketUpdateStatus body → 200400401500
Log APIs 2

The Log APIs allow to manage CyberArk application event logs. The Log interface allow for events to be recorded in the Trust Protection Foundation log table. Many API method calls…

POST
/vedsdk/log/evaluatemacro
Perform a macro translation
Venafi_WebSDK_Log_LogRest_EvaluateMacro body → 200403400401
GET
/vedsdk/log/adaptableinfo
Retrieve information about available Log Adaptable scripts
Venafi_WebSDK_Log_LogRest_AdaptableInformation → 200403400401
SSH Management APIs 36

The SSH Management APIs allow to manage device keys and keysets. This interface is valid only if you purchased SSH Manager for Machines. All product-supported operations are expos…

GET
/vedsdk/ssh/rules
Search key authorization rules
Venafi_Ssh_WebSDK_SshRestService_GetAuthRules 7 params → 200500400
POST
/vedsdk/ssh/TestDeviceConnection
Returns connection status for provided devices
Venafi_Ssh_WebSDK_SshRestService_TestDeviceConnection body → 200
POST
/vedsdk/ssh/ImportKeyUsageData
Imports key usage from a Unix or Linux host syslog.
Venafi_Ssh_WebSDK_SshRestService_ImportKeyUsageData body → 200403400401
POST
/vedsdk/ssh/KeyUsage
Finds all key usage records matching the specified filtering criteria.
Venafi_Ssh_WebSDK_SshRestService_GetKeyUsages body → 200403400401
POST
/vedsdk/ssh/RemoveKey
Marks a key for deletion.
Venafi_Ssh_WebSDK_SshRestService_Remove body → 200
POST
/vedsdk/ssh/CancelKeyOperation
Cancels any running key operation. Can also rollback a key to its original state.
Venafi_Ssh_WebSDK_SshRestService_CancelKeyOperation body → 200
POST
/vedsdk/ssh/RetryKeyOperation
Retries any failing operation (addition, removal, editing) on specified key.
Venafi_Ssh_WebSDK_SshRestService_RetryKeyOperation body → 200
POST
/vedsdk/ssh/Rotate
Starts Synchronous Rotation of a specific keyset.
Venafi_Ssh_WebSDK_SshRestService_StartRotation body → 200
POST
/vedsdk/ssh/RotateNonBlocking
Submits Rotation request of specific keyset.
Venafi_Ssh_WebSDK_SshRestService_StartRotationNonBlocking body → 200
POST
/vedsdk/ssh/RollbackNonBlocking
Submits Rollback request of specific keyset.
Venafi_Ssh_WebSDK_SshRestService_StartRollbackNonBlocking body → 200
POST
/vedsdk/ssh/CancelRotation
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.
Venafi_Ssh_WebSDK_SshRestService_CancelRotation body → 200
POST
/vedsdk/ssh/RetryRotation
Retries rotation of specified keyset.
Venafi_Ssh_WebSDK_SshRestService_RetryRotation body → 200
POST
/vedsdk/ssh/EditKeyOptions
Changes Source Restrictions, and Forced commands in an authorized keys file.
Venafi_Ssh_WebSDK_SshRestService_EditKeyOptions body → 200
POST
/vedsdk/ssh/EditSelfServiceAuthorizedKey
Changes location, notes, Source Restrictions, and Forced commands in an selfservice authorized keys.
Venafi_Ssh_WebSDK_SshRestService_EditSelfServiceAuthorizedKey body → 200
POST
/vedsdk/ssh/AddSelfServicePrivateKey
Assigns an existing keyset to a policy folder.
Venafi_Ssh_WebSDK_SshRestService_AddSelfServicePrivateKey body → 200
POST
/vedsdk/ssh/AddSelfServiceAuthorizedKey
Add an authorization key to a keyset.
Venafi_Ssh_WebSDK_SshRestService_AddSelfServiceAuthorizedKey body → 200
POST
/vedsdk/ssh/ConfirmSelfServiceKeyInstallation
Verifies that a user manually installed a private key.
Venafi_Ssh_WebSDK_SshRestService_ConfirmSelfServiceKeyInstallation body → 200
POST
/vedsdk/ssh/MoveKeysetsToPolicy
Moves a list of keysets to a policy folder.
Venafi_Ssh_WebSDK_SshRestService_MoveKeysetsToPolicy body → 200
POST
/vedsdk/ssh/ExportSelfServiceAuthorizedKey
Downloads an authorized key.
Venafi_Ssh_WebSDK_SshRestService_ExportSelfServiceAuthorizedKey body → 200
POST
/vedsdk/ssh/ExportSelfServicePrivateKey
Downloads a private key.
Venafi_Ssh_WebSDK_SshRestService_ExportSelfServicePrivateKey body → 200
POST
/vedsdk/ssh/SkipKeyRotation
Skip key rotation.
Venafi_Ssh_WebSDK_SshRestService_SkipKeyRotation body → 200
POST
/vedsdk/ssh/AddUserPrivateKey
Installs a new user private key on a device.
Venafi_Ssh_WebSDK_SshRestService_AddUserPrivateKey body → 200
POST
/vedsdk/ssh/AddHostPrivateKey
Creates and installs a new private key on a host device.
Venafi_Ssh_WebSDK_SshRestService_AddHostPrivateKey body → 200
POST
/vedsdk/ssh/AddAuthorizedKey
Creates an Open SSH Authorized key for provisioning to a device.
Venafi_Ssh_WebSDK_SshRestService_AddAuthorizedKey body → 200
POST
/vedsdk/ssh/AddKnownHostKey
Creates a public key for a host.
Venafi_Ssh_WebSDK_SshRestService_AddKnownHostKey body → 200
POST
/vedsdk/ssh/ImportAuthorizedKey
Adds or reuses a Base64 public key for a device.
Venafi_Ssh_WebSDK_SshRestService_ImportAuthorizedKey body → 200
POST
/vedsdk/ssh/ImportPrivateKey
Adds or reuses a Base64 private key for a device.
Venafi_Ssh_WebSDK_SshRestService_ImportPrivateKey body → 200
POST
/vedsdk/ssh/ChangePrivateKeyPassphrase
Changes the private key passphrase for a keyset.
Venafi_Ssh_WebSDK_SshRestService_ChangePrivateKeyPassphrase body → 200
POST
/vedsdk/ssh/SetUnmatchedKeysetPassphrase
Sets the passphrase on a keyset that is missing the encrypted private key.
Venafi_Ssh_WebSDK_SshRestService_SetUnmatchedKeysetPasshrase body → 200
POST
/vedsdk/ssh/DeleteUnmatchedKeyset
Deletes an unmatched keyset that is missing the encrypted private key passphrase and .pub file extension.
Venafi_Ssh_WebSDK_SshRestService_DeleteUnmatchedKeyset body → 200
POST
/vedsdk/ssh/KeyDetails
Returns detailed key data.
Venafi_Ssh_WebSDK_SshRestService_GetKeyDetails body → 200
POST
/vedsdk/ssh/Devices
Finds devices in the Policy tree that match the filtering criteria.
Venafi_Ssh_WebSDK_SshRestService_GetDevices body → 200
GET
/vedsdk/ssh/KeysetDetails
Provides information about every device that shares the same keyset.
Venafi_Ssh_WebSDK_SshRestService_GetKeysetDetail 2 params → 200
POST
/vedsdk/ssh/KeysetDetails
Returns private and public key pairs that identify details about a device
Venafi_Ssh_WebSDK_SshRestService_GetKeysetDetails body → 200
POST
/vedsdk/ssh/ApproveKeyOperation
Approves any key operation that has a Pending Approval status in a workflow.
Venafi_Ssh_WebSDK_SshRestService_ApproveKeyOperation body → 200
POST
/vedsdk/ssh/RejectKeyOperation
Rejects any key operation that has a Pending Approval status in a workflow.
Venafi_Ssh_WebSDK_SshRestService_RejectKeyOperation body → 200
SSH Certificate APIs 5

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.

POST
/vedsdk/sshcertificates/request
Requests a new SSH certificate
Venafi_SshCertificate_WebSDK_SshCertificateRestService_RequestCertificate body → 200400401
POST
/vedsdk/sshcertificates/retrieve
Returns the available certificate data and optional private key information for an enrolled SSH certificate.
Venafi_SshCertificate_WebSDK_SshCertificateRestService_RetrieveCertificate body → 200
GET
/vedsdk/sshcertificates/template/available
Returns a list of SSH CA templates the current user can request certificates from.
Venafi_SshCertificate_WebSDK_SshCertificateRestService_GetAvailableTemplates → 200
POST
/vedsdk/sshcertificates/template/retrieve
Returns information about an SSH CA template.
Venafi_SshCertificate_WebSDK_SshCertificateRestService_RetrieveTemplate body → 200
POST
/vedsdk/sshcertificates/CaKeyPair/create
Create new CA Keypair.
Venafi_SshCertificate_WebSDK_SshCertificateRestService_CreateNewCAKeypair body → 200400401
Teams APIs 9

The Teams interface allows you to associate AD, LDAP, and local Identities to Policy assets and CyberArk products.

POST
/vedsdk/teams/
Create a team
Venafi_Teams_WebSDK_TeamsRest_CreateTeam body → 200400
GET
/vedsdk/teams/{prefix}/{principal}
Get a team
Venafi_Teams_WebSDK_TeamsRest_GetTeam 2 params → 200400
PUT
/vedsdk/teams/{prefix}/{principal}
Update a team
Venafi_Teams_WebSDK_TeamsRest_UpdateTeam 2 params body → 200400
DELETE
/vedsdk/teams/{prefix}/{principal}
Delete a team
Venafi_Teams_WebSDK_TeamsRest_DeleteTeam 2 params → 200400
PUT
/vedsdk/teams/addteammembers
Add members to a team
Venafi_Teams_WebSDK_TeamsRest_AddTeamMembers body → 200400
PUT
/vedsdk/teams/removeteammembers
Remove members from a team
Venafi_Teams_WebSDK_TeamsRest_RemoveTeamMembers body → 200400
PUT
/vedsdk/teams/addteamowners
Add owners to a team
Venafi_Teams_WebSDK_TeamsRest_AddTeamOwners body → 200400
PUT
/vedsdk/teams/demoteteamowners
Demote team owners
Venafi_Teams_WebSDK_TeamsRest_DemoteTeamOwners body → 200400
PUT
/vedsdk/teams/renameteam
Rename a team
Venafi_Teams_WebSDK_TeamsRest_RenameTeam body → 200400

Schemas 656

The contract defines 656 schemas that model the data the API accepts and returns. The most detailed are WebSDK_CertificateRequest_RequestRequest (39 properties), WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest (22 properties), WebSDK_CertificateRequest_DetailedCertificateResult (22 properties), SshCertificate_WebSDK_DataContract_Requests_RequestNewCertificateWebRequest (18 properties). Each schema is shown below with its type and property counts.

Core_IdentityType
integer
0: Undefined Undefined 1: User User object 2: Group Group object 4: Container Container of users and groups 8: DistributionList Distribution List 16: Machine M…
Core_IdentityEntry_EntryState
integer
0: Normal No special state associated with the entry 1: Disabled The identity has been disabled 2: LockedOut The identity has been locked out 4: Deleted The id…
Nullable_1_Core_Cryptography_SubjectAltNameType_
integer
2: DNS Specifies the SubjestAltName is a DNS entry 1: RFC822 Specifies the SubjestAltName is an Email address 1: Email Specifies the SubjestAltName is an Email…
Nullable_1_Core_Revocation_RevocationReason_
integer
0: Unspecified No reason given (RFC) none 1: KeyCompromise The key was compromised (RFC) An issued certificate's private key was compromised 2: CACompromise Th…
CodeSigning_SignRight
integer
0: None No rights 1: Admin Administrator (full) rights 2: Use The right to use a key for signing 4: Audit The right to audit a project 8: Owner The right indic…
CodeSigning_SignTemplateValueInfo
integer
1: SuggestedList The value represents a list of possible values that may be disregarded 2: LockedList The value represents an exhaustive list of possible choic…
Core_MetadataType
integer
0: Unknown Unknown 1: Text Text input field 2: List List selection 3: Choice Single/Multiple choice 4: DateTime Date/Time picker 5: Identity Identity selector…
CodeSigning_SignProjectStatus
integer
0: Disabled The project is currently disabled 1: Enabled The project is enabled, and ready to be used 2: Draft The project is being created and cannot be used…
CodeSigning_SignResult
integer
0: None Undefined result 1: Success The operation was successful 2: InsufficientPermission Insufficient permission to perform the operation 3: CreateFailure Fa…
Core_CredentialResult
integer
1: Success Operation completed successfully. 2: InvalidArgument An invalid method argument was passed to a method. 3: InvalidArgumentRange An argument value is…
Core_Cryptography_Cryptoki_CryptokiObjectType
integer
0: Data 1: Certificate 2: PublicKey 3: PrivateKey 4: SecretKey 5: HwFeature 6: DomainParameters 7: Mechanism 8: OtpKey
Core_Cryptography_Cryptoki_CryptokiKeyType
integer
0: RSA RSA Asymmetric Key 1: DSA DSA (Digital Signature Algorithm) Asymmetric Key 2: DH The Diffie-Hellman Asymmetric Key 3: EC EC (Elliptic-Curve) Asymmetric…
Core_PkixNISTStrengthCategory
integer
0: Uncategorized The algorithm has not yet received a NIST security level categorization 65536: NISTSecurityCategory1 NIST Security Category 1 131072: NISTSecu…
Core_FlowTicketRejectionStatus
integer
0: None Ticket has not been rejected 1: Retry Process has an issue, fix the issue and retry from the current stage 2: Final Process cannot complete and must be…
Core_FlowTicketResult
integer
0: Success The ticket operation was successful 1: InsufficientPermission Insufficient permission to perform the requested operation 2: TicketNotFound The reque…
Core_Preferences_ResultCode
integer
0: Success The success 1: DatabaseError The database error 2: MissingDSN The missing DSN 3: MissingDatabaseName The missing database name 4: AssemblyNotSignedO…
Core_RecycleBinResult
integer
0: Success The request completed succesfully 1: AdminRequired Only an administrator can make the request 2: ObjectDoesNotExist The provided object name does no…
Core_RecycleBinRestoreState
integer
0: Unknown Restoration state has not been determined 1: Possible The item can be restored 2: SameNameExists The item cannot be restored because an item with th…
Core_RecycledItemDetail_DetailType
integer
0: Config Config object 1: Vault Vault entry
Core_VaultType
integer
0: None 1: PrivateKey Indicates the stored data is a Private Key 2: Certificate Indicates the stored data is a Certificate 4: PKCS12 Indicates the stored data…
Web_SDK_Authentication_OAuthOrderByField
integer
0: Default No order specified 1: Name Order results by name 2: Vendor Order results by vendor 3: AccessValidity Order results by access validity 4: GrantValidi…
Web_SDK_Authentication_OAuthRole
integer
0: User User can see only his/her own items (ie, anything related to grants issued to a specific verified identity) 1: Auditor User can see everything but chan…
Web_SDK_Authentication_OAuthResult
integer
0: Success The request completed successfully 1: Failure The request could not be completed successfully 2: ApplicationNotFound The requested application could…
Core_StatsTier
integer
0: Live The live data tier, where data is currently being modified 1: Hour The hourly tier. Aggregate data for previous hours is kept 2: Day The daily tier. Ag…
Permissions_PermissionsResult
integer
0: None No result set 1: Success The operation completed successfully 2: RemoteError A remote request failed; see Error property for details 3: MissingObjectAr…
Core_ConfigResult
integer
0: None 1: Success Operation completed successfully. 2: InvalidArgument An invalid method argument was passed to a method. 3: InvalidArgumentRange An argument…
Core_SchemaClass_Properties
integer
0: None A default internal enumeration. 1: NonRemovable Obsolete 2: NonEffective No objects, of the schema class, can be created. 4: Container Objects, of this…
Core_SchemaAttribute_Syntaxes
integer
0: None A default internal enumeration. 2: Boolean The attribute value is a boolean. 2: Bool The attribute value is a boolean. 5: CaseIgnoreString The attribut…
Core_SchemaAttribute_Properties
integer
0: SingleValued Default 0: None Default 1: NonRemovable Obsolete 2: Hidden Obsolete 4: PublicRead Obsolete 8: ReadOnly Obsolete 16: MultiValued Values, of this…
Core_ConfigRights
integer
0: None No privileges. 1: SchemaRead Read schema class and, or, attribute definitions. 2: SchemaAdd Add schema class and, or, attribute definitions. 4: SchemaR…
Core_ConfigPolicy_Properties
integer
0: None An unsed internal enumeration. 1: Locked The effective attribute value is locked by the owning object. This field is a flag and the actual value will b…
Core_SecretStoreResult
integer
0: Success Indicates the method completed succesfully. 1: InvalidCallingAssembly Indicates the calling assembly is not signed by Venafi. 2: CreateDatabaseError…
Core_NestedGroupResolveType
integer
0: DoNotResolve Do not resolve nested groups 1: Resolve Resolve nested groups 2: DriverDefault Let the driver determine whether or not to resolve nested groups
Core_IdentityResult
integer
1: Success Operation completed successfully. 2: InvalidArgument An invalid method argument was passed to a method. 3: InvalidArgumentRange An argument value is…
Core_MetadataResult
integer
0: Success Success 1: InvalidConfigObject An invalid or nullConfig object was passed 2: InvalidDN A null or empty DN string was passed 3: InvalidName A null or…
Nullable_1_Core_VaultType_
integer
0: None 1: PrivateKey Indicates the stored data is a Private Key 2: Certificate Indicates the stored data is a Certificate 4: PKCS12 Indicates the stored data…
Core_WorkflowResult
integer
0: None None 1: Success Success 2: GenericFailure Nondescript failure 3: TicketDoesNotExist The referenced ticket does not exist 4: InsufficientPrivileges Not…
Core_Severity
integer
1: Emergency Emergency, the system is unusable. 2: Alert Action must be taken immediately. 3: Critical Critical conditions are occurring. 4: Error An error occ…
Core_LogFlags
integer
0: None No flags 1: Synchronous Request synchronous logging 2: NonBlocking Request immediate return of Log APIs 4: NonCaching Do not cache the event 8: SignedC…
Core_LogResult
integer
0: Success Success 1: Failure General error 2: StringTooLong A provided string was too long 3: DataToLarge The data blob was too long 4: ComponentTooLong The c…
Nullable_1_Ssh_WebSDK_DataContract_SshKeyUsageAlert_
integer
1: UntrackedKey Untracked key. 2: UnknownClient Unknown client.
ProductLogic_Ssh_Entities_PolicyViolation
integer
1: IsRootAccessOrphan Root access orphan 2: IsClientAccessOrphan Client access orphan 3: IsPrivateKeyOrphan Private key orphan 4: IsKnownHostOrphan Known host…
Ssh_WebSDK_DataContract_KeyProcessStatus
integer
0: NoStatus Indicates that no status is available for the key. 1: Provisioning Indicates that key is being provisioned (added or edited) to its device. 2: Remo…
Ssh_WebSDK_DataContract_KeysetProcessStatus
integer
5: Rotating Indicates that keyset is being rotated. 6: FailedToRotate Indicates that keyset had error during rotation. 7: KeyOperationRunning Indicates that at…
Web_SDK_Authentication_OAuthError
object
REST OAuth Error Response
2 properties
Drivers_Applications_HashiCorp_REST_CreateRoleRequest_
object
2 properties 2 required
Drivers_Applications_HashiCorp_REST_CreateRoleResponse
object
Response for role creation request.
2 properties
Drivers_Applications_HashiCorp_REST_Role
object
HashiCorp Role policy object.
14 properties
Drivers_Applications_HashiCorp_REST_CreatePkiResponse
object
Response for PKI create request.
4 properties
Drivers_Applications_HashiCorp_REST_CreatePkiRequest
object
Create HashiCorp PKI request.
9 properties
Drivers_Applications_HashiCorp_REST_Pkis
object
List of all PKI objects.
2 properties
Drivers_Applications_HashiCorp_REST_PkiResponse
object
PKI details.
10 properties
Web_SDK_Authentication_AuthorizeOAuthRequest_device
object
2 properties
Web_SDK_Authentication_AuthorizeOAuthResponse
object
Holds information about a particular access grant
15 properties
Web_SDK_Authentication_AuthorizeOAuthResponse_device
object
4 properties
Web_SDK_Authentication_AuthError
object
Class to generate OAuth Authentication Server error responses (See RFC6749, Section 5.2)
2 properties
Web_SDK_Authentication_AuthorizeOAuthRequest_oauth
object
4 properties
Web_SDK_Authentication_AuthorizeOAuthResponse_oauth
object
4 properties
Web_SDK_Authentication_AuthorizeOAuthRequest_integrated
object
2 properties
Web_SDK_Authentication_AuthorizeOAuthResponse_integrated
object
4 properties
Web_SDK_Authentication_AuthorizeOAuthRequest_certificate
object
2 properties
Web_SDK_Authentication_AuthorizeOAuthResponse_certificate
object
4 properties
Web_SDK_Authentication_AuthorizeOAuthRequest_jwt
object
3 properties
Web_SDK_Authentication_AuthorizeOAuthResponse_jwt
object
4 properties
Web_SDK_Authentication_TokenOAuthRequest
object
RFC6749 token request.
4 properties
Web_SDK_Authentication_AuthorizeVerifyResponse
object
Holds information about a particular access grant
13 properties
WebSDK_CertificateRequest_RetrieveByVaultIdRequest_Retrieve__vaultId_
object
8 properties 5 required
WebSDK_CertificateRequest_RetrieveResponse
object
The class for certificate retrieve response.
6 properties
WebSDK_CertificateRequest_RetrieveResponse_Retrieve__vaultId_
object
6 properties
IO_Stream
object
WebSDK_CertificateRequest_PreviousVersionsResponse
object
The class for GET certificate previous versions method response.
4 properties
WebSDK_CertificateRequest_ValidateRequest
object
Request to validate certificates.
2 properties
WebSDK_CertificateRequest_ValidateResponse
object
Certificates validate response.
5 properties
WebSDK_CertificateRequest_PutRequest__guid_
object
1 property 1 required
WebSDK_CertificateRequest_PutResponse
object
The class for put certificate method response.
3 properties
WebSDK_CertificateRequest_CheckPolicyRequest
object
Check policy request.
2 properties
WebSDK_CertificateRequest_CheckPolicyResponse
object
Check policy response.
3 properties
WebSDK_CertificateRequest_RequestRequest
object
The class for certificate request method response.
39 properties
WebSDK_CertificateRequest_RequestResponse
object
The class for certificate request method response.
10 properties
WebSDK_CertificateRequest_RequestResponse_Request
object
10 properties
WebSDK_CertificateRequest_RetrieveRequest_Retrieve
object
9 properties 2 required
WebSDK_CertificateRequest_RenewRequest
object
The class for renew method request.
11 properties
WebSDK_CertificateRequest_RenewResponse
object
The class for renew method response.
7 properties
WebSDK_CertificateRequest_RenewResponse_Renew
object
5 properties
WebSDK_CertificateRequest_RevokeRequest
object
The class for certificate revoke method request.
6 properties
WebSDK_CertificateRequest_RevokeResponse
object
The class for certificate revoke method response.
5 properties
WebSDK_CertificateRequest_CertificateResults
object
Result class containing list of results as well as paging links and count information.
5 properties
WebSDK_CertificateRequest_DetailedCertificateResult
object
Detailed Certificate object containing all information for a certificate.
22 properties
WebSDK_CertificateRequest_AssociateRequest
object
Request to associate certificate and applications.
3 properties
WebSDK_CertificateRequest_AssociateResponse
object
Certificate associate response.
3 properties
WebSDK_CertificateRequest_DissociateRequest
object
Request to dissociate certificate and applications.
3 properties
WebSDK_CertificateRequest_DissociateResponse
object
Certificate dissociate response.
2 properties
WebSDK_CertificateRequest_PushRequest
object
Request for certificate provisioning to some or all consumers which are valid application DNs for this certificate.
3 properties
WebSDK_CertificateRequest_PushResponse
object
Certificate push response.
3 properties
WebSDK_CertificateRequest_DeleteResponse
object
The delete method response.
3 properties
WebSDK_CertificateRequest_ImportRequest
object
The import method request.
7 properties
WebSDK_CertificateRequest_ImportResponse
object
The class for import method response.
6 properties
WebSDK_CertificateRequest_ResetRequest
object
The class for certificate reset method request.
4 properties
WebSDK_CertificateRequest_ResetResponse
object
The class for certificate reset response.
5 properties
WebSDK_CertificateRequest_RetryRequest
object
The class for certificate retry method request.
2 properties
WebSDK_CertificateRequest_RetryResponse
object
The class for certificate retry method response.
2 properties
WebSDK_CertificateRequest_ValidationResultsResponse
object
The class for certificate validation results retrieve method response
2 properties
WebSDK_CertificateRequest_DiscoveryImportRequest
object
Request to import discovery results.
2 properties
WebSDK_CertificateRequest_DiscoveryImportResponse
object
Discovery import response.
7 properties
WebSDK_CertificateRequest_DiscoveryDeleteResponse
object
The Network Discovery delete method response.
2 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_FindEnvironment
object
1 property
WebSDK_Product_CodeSigning_CodeSigningResponse_FindEnvironment
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CreateEnvironment
object
8 properties 3 required
WebSDK_Product_CodeSigning_CodeSigningResponse_CreateEnvironment
object
2 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RenewEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_RenewEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateEnvironment
object
6 properties 6 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateEnvironment
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateProjects
object
2 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateProjects
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetProject
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetProject
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CreateProject
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_CreateProject
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProject
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProject
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateProjectStatus
object
4 properties 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateProjectStatus
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteProject
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteProject
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RenameProject
object
4 properties 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RenameProject
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateTemplates
object
1 property
WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateTemplates
object
9 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetTemplate
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetTemplate
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CreateTemplate
object
3 properties 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_CreateTemplate
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateTemplate
object
2 properties 3 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateTemplate
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteTemplate
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteTemplate
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RenameTemplate
object
3 properties 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RenameTemplate
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplications
object
1 property
WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplications
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplication
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplication
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplication
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplication
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplication
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplication
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplication
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplication
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplication
object
2 properties 2 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplication
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CountReferences
object
2 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_CountReferences
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateReferences
object
6 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateReferences
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_EnumerateApplicationCollections
object
1 property
WebSDK_Product_CodeSigning_CodeSigningResponse_EnumerateApplicationCollections
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollection
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollection
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMemberDNs
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMemberDNs
object
6 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetApplicationCollectionMembers
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetApplicationCollectionMembers
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_CreateApplicationCollection
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_CreateApplicationCollection
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_UpdateApplicationCollection
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_UpdateApplicationCollection
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_DeleteApplicationCollection
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_DeleteApplicationCollection
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RenameApplicationCollection
object
2 properties 2 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RenameApplicationCollection
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_GetGlobalConfiguration
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_SetGlobalConfiguration
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_SetGlobalConfiguration
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_AddAdministrator
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_AddAdministrator
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveAdministrator
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveAdministrator
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_AddApplicationAdministrator
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_AddApplicationAdministrator
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveApplicationAdministrator
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveApplicationAdministrator
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_AddProjectApprover
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_AddProjectApprover
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RemoveProjectApprover
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RemoveProjectApprover
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetRight
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_GetRight
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetTrusteeRights
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_GetTrusteeRights
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_GetObjectRights
object
1 property 1 required
WebSDK_Product_CodeSigning_CodeSigningResponse_GetObjectRights
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_AddPreApproval
object
8 properties 5 required
WebSDK_Product_CodeSigning_CodeSigningResponse_AddPreApproval
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RunMacro
object
4 properties 4 required
WebSDK_Product_CodeSigning_CodeSigningResponse_RunMacro
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_RetrieveArchiveEntries
object
3 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_RetrieveArchiveEntries
object
4 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_ExportSignArchive
object
5 properties
WebSDK_Product_CodeSigning_CodeSigningRequest_Create
object
8 properties
WebSDK_Product_CodeSigning_CodeSigningResponse_Create
object
3 properties
WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_create
object
4 properties 3 required
WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_create
object
1 property
WebSDK_CRAdaptableRest_AdaptableCredentialsWebRequest_update
object
4 properties 4 required
WebSDK_CRAdaptableRest_AdaptableCredentialsWebResponse_update
object
1 property
WebSDK_CRCyberArkRest_CyberArkCredentialsWebRequest
object
CyberArk credentials web request.
22 properties
WebSDK_CRCyberArkRest_CyberArkCredentialsWebResponse
object
CyberArk credentials web response.
17 properties
Web_Hsm_HsmJWTRequest_signjwt
object
5 properties 5 required
Web_Hsm_HsmJWTResponse_signjwt
object
2 properties
Web_Hsm_HsmBaseResponse_IsHsm
object
4 properties
Web_Hsm_HsmCryptoRequest_sign
object
14 properties 6 required
Web_Hsm_HsmCryptoResponse
object
Data object for a cryptographic operation response.
5 properties
Web_Hsm_HsmCryptoRequest_decrypt
object
2 properties 2 required
Web_Hsm_HsmCryptoResponse_decrypt
object
4 properties
Web_Hsm_HsmCryptoRequest_derive
object
3 properties 3 required
Web_Hsm_HsmCryptoResponse_derive
object
4 properties
Web_Hsm_HsmGpgRequest_getgpgpublickey
object
2 properties 1 required
Web_Hsm_HsmGpgResponse_getgpgpublickey
object
4 properties
Web_Hsm_HsmStoreRequest_storeobject
object
6 properties 6 required
Web_Hsm_HsmStoreResponse
object
Data object for an object retrieval response.
2 properties
Web_Hsm_HsmObjectRequest_getchain
object
1 property
Web_Hsm_HsmObjectResponse_getchain
object
3 properties
Web_Hsm_HsmObjectRequest_getobjects
object
6 properties
Web_Hsm_HsmObjectResponse_getobjects
object
5 properties
Web_Hsm_HsmTelemetryRequest
object
Data object for sending code sign client telemetry.
7 properties
Web_Hsm_HsmTelemetryResponse
object
Data object for a telemetry submission response.
2 properties
ClientWebSDK_DataContracts_BulkRequest
object
Request to perform bulk operation
2 properties
ClientWebSDK_DataContracts_DeleteResponse_delete
object
1 property
Core_WebSDK_AlgorithmSelectorWebRequest_get
object
1 property 1 required
Core_WebSDK_AlgorithmSelectorWebResponse_get
object
3 properties
Core_WebSDK_AlgorithmSelectorWebRequest_commit
object
2 properties 2 required
Core_WebSDK_AlgorithmSelectorWebResponse_commit
object
2 properties
Core_WebSDK_AlgorithmSelectorWebRequest_find
object
2 properties 1 required
Core_WebSDK_AlgorithmSelectorWebResponse_find
object
3 properties
Core_WebSDK_AlgorithmSelectorWebRequest_getpolicy
object
2 properties 2 required
Core_WebSDK_AlgorithmSelectorWebResponse_getpolicy
object
3 properties
Core_WebSDK_AlgorithmSelectorWebRequest_commitpolicy
object
3 properties 3 required
Core_WebSDK_AlgorithmSelectorWebResponse_commitpolicy
object
2 properties
Core_WebSDK_AlgorithmSelectorWebRequest_getselector
object
1 property 1 required
Core_WebSDK_AlgorithmSelectorWebResponse_getselector
object
3 properties
Core_WebSDK_AlgorithmSelectorWebResponse_getallselectors
object
3 properties
Core_WebSDK_AlgorithmSelectorWebRequest_getallowedalgorithms
object
2 properties 1 required
Core_WebSDK_AlgorithmSelectorWebResponse_getallowedalgorithms
object
3 properties
Core_WebSDK_AlgorithmSelectorWebResponse_getglobalalgorithms
object
3 properties
Core_WebSDK_AlgorithmSelectorWebRequest_setglobalalgorithms
object
1 property 1 required
Core_WebSDK_AlgorithmSelectorWebResponse_setglobalalgorithms
object
2 properties
Core_WebSDK_FlowTicketRequest_enumerate
object
3 properties 3 required
Core_WebSDK_FlowTicketResponse_enumerate
object
2 properties
Core_WebSDK_FlowTicketRequest_enumerateapproved
object
3 properties 3 required
Core_WebSDK_FlowTicketResponse_enumerateapproved
object
2 properties
Core_WebSDK_FlowTicketRequest_approve
object
6 properties 1 required
Core_WebSDK_FlowTicketResponse_approve
object
2 properties
Core_WebSDK_FlowTicketRequest_reject
object
4 properties 2 required
Core_WebSDK_FlowTicketResponse_reject
object
2 properties
Core_WebSDK_FlowTicketRequest_count
object
1 property
Core_WebSDK_FlowTicketResponse_count
object
3 properties
Core_WebSDK_FlowTicketRequest_countapproved
object
1 property
Core_WebSDK_FlowTicketResponse_countapproved
object
3 properties
Core_WebSDK_FlowTicketRequest_load
object
1 property 1 required
Core_WebSDK_FlowTicketResponse_load
object
3 properties
Core_WebSDK_FlowTicketRequest_update
object
6 properties 1 required
Core_WebSDK_FlowTicketResponse_update
object
2 properties
Core_WebSDK_Obsolete_VersionResponse
object
Class for platform version response.
1 property
Core_WebSDK_Obsolete_UpgradeStatusResponse
object
Upgrade status response
2 properties
Core_WebSDK_Obsolete_UpgradeSummaryResponse
object
Status of an upgrade
2 properties
Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engine
object
2 properties
Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engines
object
2 properties
Core_WebSDK_Obsolete_GroupingIdsResposne
object
Grouping Ids Response
2 properties
Core_WebSDK_BusStatusWebResponse_getstatus
object
2 properties
Core_WebSDK_BusStatusWebRequest_getmeshdnsname
object
1 property
Core_WebSDK_BusStatusWebResponse_getmeshdnsname
object
4 properties
Core_WebSDK_BusStatusWebRequest_setmeshdnsname
object
2 properties
Core_WebSDK_BusStatusWebResponse_setmeshdnsname
object
2 properties
Core_WebSDK_PreferenceWebResponse
object
Data class for handling preference web response
2 properties
Core_WebSDK_PreferenceWebRequest
object
Data class for handling preference web request
1 property
Core_WebSDK_RecycleBinWebRequest
object
Class to represent a RecycleBin request for the WebSDK
7 properties
Core_WebSDK_RecycleBinWebResponse_getcontents
object
4 properties
Core_WebSDK_RecycleBinWebRequest_getitem
object
1 property
Core_WebSDK_RecycleBinWebResponse_getitem
object
3 properties
Core_WebSDK_RecycleBinWebRequest_getitemdetails
object
1 property
Core_WebSDK_RecycleBinWebResponse_getitemdetails
object
3 properties
Core_WebSDK_RecycleBinWebRequest_restore
object
1 property
Core_WebSDK_RecycleBinWebResponse_restore
object
2 properties
Core_WebSDK_RecycleBinWebRequest_purge
object
1 property
Core_WebSDK_RecycleBinWebResponse_purge
object
2 properties
Core_WebSDK_RecycleBinWebResponse_empty
object
2 properties
Core_WebSDK_RecycleBinWebRequest_setconfiguration
object
2 properties
Core_WebSDK_RecycleBinWebResponse_setconfiguration
object
2 properties
Core_WebSDK_RecycleBinWebResponse_getconfiguration
object
4 properties
Core_WebSDK_RecycleBinWebRequest_purgetask
object
3 properties
Core_WebSDK_RecycleBinWebResponse_purgetask
object
2 properties
Core_WebSDK_RecycleBinWebRequest_deletiontask
object
2 properties
Core_WebSDK_RecycleBinWebResponse_deletiontask
object
2 properties
Core_WebSDK_OAuthWebRequest_grantrole
object
3 properties
Core_WebSDK_OAuthWebResponse_grantrole
object
3 properties
Core_WebSDK_OAuthWebRequest_revokerole
object
2 properties
Core_WebSDK_OAuthWebResponse_revokerole
object
3 properties
Core_WebSDK_OAuthWebResponse_listroles
object
4 properties
Core_WebSDK_OAuthWebResponse_getrole
object
4 properties
Core_WebSDK_OAuthWebResponse_getconfiguration
object
4 properties
Core_WebSDK_OAuthWebRequest_setconfiguration
object
1 property
Core_WebSDK_OAuthWebResponse_setconfiguration
object
3 properties
Core_WebSDK_OAuthWebRequest_createapplication
object
10 properties
Core_WebSDK_OAuthWebResponse_createapplication
object
4 properties
Core_WebSDK_OAuthWebRequest_enumerateapplications
object
4 properties
Core_WebSDK_OAuthWebResponse_enumerateapplications
object
4 properties
Core_WebSDK_OAuthWebRequest_getapplications
object
2 properties
Core_WebSDK_OAuthWebResponse_getapplications
object
4 properties
Core_WebSDK_OAuthWebRequest_getapplication
object
1 property
Core_WebSDK_OAuthWebResponse_getapplication
object
4 properties
Core_WebSDK_OAuthWebRequest_updateapplication
object
1 property
Core_WebSDK_OAuthWebResponse_updateapplication
object
3 properties
Core_WebSDK_OAuthWebRequest_deleteapplication
object
1 property
Core_WebSDK_OAuthWebResponse_deleteapplication
object
3 properties
Core_WebSDK_OAuthWebResponse_getscopes
object
4 properties
Core_WebSDK_OAuthWebRequest_getgrants
object
7 properties
Core_WebSDK_OAuthWebResponse_getgrants
object
4 properties
Core_WebSDK_OAuthWebRequest_enumerategrants
object
6 properties
Core_WebSDK_OAuthWebResponse_enumerategrants
object
4 properties
Core_WebSDK_OAuthWebRequest_revokegrants
object
2 properties
Core_WebSDK_OAuthWebResponse_revokegrants
object
3 properties
Core_WebSDK_OAuthWebRequest_createrule
object
7 properties
Core_WebSDK_OAuthWebResponse_createrule
object
4 properties
Core_WebSDK_OAuthWebRequest_getrules
object
7 properties
Core_WebSDK_OAuthWebResponse_getrules
object
4 properties
Core_WebSDK_OAuthWebRequest_enumeraterules
object
6 properties
Core_WebSDK_OAuthWebResponse_enumeraterules
object
4 properties
Core_WebSDK_OAuthWebRequest_updaterule
object
1 property
Core_WebSDK_OAuthWebResponse_updaterule
object
3 properties
Core_WebSDK_OAuthWebRequest_deleterule
object
2 properties
Core_WebSDK_OAuthWebResponse_deleterule
object
3 properties
Core_WebSDK_OAuthWebRequest_deleterules
object
2 properties
Core_WebSDK_OAuthWebResponse_deleterules
object
3 properties
Core_WebSDK_OAuthWebRequest_grantcount
object
1 property
Core_WebSDK_OAuthWebResponse_grantcount
object
4 properties
Core_WebSDK_OAuthWebRequest_usercount
object
1 property
Core_WebSDK_OAuthWebResponse_usercount
object
4 properties
Core_WebSDK_OAuthWebRequest_createjwtmapping
object
8 properties
Core_WebSDK_OAuthWebResponse_createjwtmapping
object
4 properties
Core_WebSDK_OAuthWebRequest_enumeratejwtmappings
object
5 properties
Core_WebSDK_OAuthWebResponse_enumeratejwtmappings
object
4 properties
Core_WebSDK_OAuthWebRequest_getjwtmappings
object
3 properties
Core_WebSDK_OAuthWebResponse_getjwtmappings
object
4 properties
Core_WebSDK_OAuthWebRequest_getjwtmapping
object
2 properties
Core_WebSDK_OAuthWebResponse_getjwtmapping
object
4 properties
Core_WebSDK_OAuthWebRequest_updatejwtmapping
object
1 property
Core_WebSDK_OAuthWebResponse_updatejwtmapping
object
3 properties
Core_WebSDK_OAuthWebRequest_deletejwtmapping
object
1 property
Core_WebSDK_OAuthWebResponse_deletejwtmapping
object
3 properties
Core_WebSDK_StatsWebRequest_createcounter
object
8 properties 2 required
Core_WebSDK_StatsWebResponse_createcounter
object
2 properties
Core_WebSDK_StatsWebRequest_deletecounter
object
1 property 1 required
Core_WebSDK_StatsWebResponse_deletecounter
object
2 properties
Core_WebSDK_StatsWebRequest_renamecounter
object
2 properties 2 required
Core_WebSDK_StatsWebResponse_renamecounter
object
2 properties
Core_WebSDK_StatsWebRequest_updatecounter
object
7 properties 1 required
Core_WebSDK_StatsWebResponse_updatecounter
object
2 properties
Core_WebSDK_StatsWebRequest_getcounter
object
1 property 1 required
Core_WebSDK_StatsWebResponse_getcounter
object
3 properties
Core_WebSDK_StatsWebRequest_getcounters
object
1 property
Core_WebSDK_StatsWebResponse_getcounters
object
3 properties
Core_WebSDK_StatsWebResponse_countercontainers
object
3 properties
Core_WebSDK_StatsWebRequest_query
object
9 properties 1 required
Core_WebSDK_StatsWebResponse_query
object
3 properties
Core_WebSDK_StatsWebRequest_querytags
object
3 properties 1 required
Core_WebSDK_StatsWebResponse_querytags
object
5 properties
Core_WebSDK_EnginesResponse
object
All engines
1 property
Core_WebSDK_FolderRestrictionsResponse
object
Folder Restrictions Response
1 property
Core_WebSDK_EngineRestrictionsResponse
object
Engine Restrictions Response
1 property
Core_WebSDK_EngineRestrictionsRequest_engine__engineGuid_
object
1 property 1 required
Core_WebSDK_AddOperationResponse
object
Represents request to add a new part
2 properties
Core_WebSDK_FolderRestrictionsRequest
object
Represents request to add a new partition management restrictions
1 property
Core_WebSDK_PermissionsWebRequest
object
4 properties
Core_WebSDK_PermissionsWebRequest_getprincipals
object
2 properties
Core_WebSDK_PermissionsWebResponse_getprincipals
object
2 properties
Core_WebSDK_PermissionsWebRequest_getpermissions
object
3 properties
Core_WebSDK_PermissionsWebResponse_getpermissions
object
2 properties
Core_WebSDK_PermissionsWebRequest_geteffectivepermissions
object
3 properties
Core_WebSDK_PermissionsWebResponse_geteffectivepermissions
object
2 properties
Core_WebSDK_PermissionsWebResponse_grantpermissions
object
1 property
Core_WebSDK_PermissionsWebRequest_revokepermissions
object
3 properties
Core_WebSDK_PermissionsWebResponse_revokepermissions
object
1 property
Core_WebSDK_PermissionsWebResponse_replacepermissions
object
1 property
Core_WebSDK_PermissionsWebResponse_refresh
object
1 property
Core_WebSDK_AssignedPermissionsResponse
object
3 properties
Core_WebSDK_EffectivePermissionsResponse
object
Data class representing REST permission response
2 properties
Core_WebSDK_ConfigWebRequest_enumerate
object
3 properties 3 required
Core_WebSDK_ConfigWebResponse_enumerate
object
3 properties
Core_WebSDK_ConfigWebRequest_enumerateall
object
2 properties 2 required
Core_WebSDK_ConfigWebResponse_enumerateall
object
3 properties
Core_WebSDK_ConfigWebRequest_enumeratepolicies
object
2 properties
Core_WebSDK_ConfigWebResponse_enumeratepolicies
object
3 properties
Core_WebSDK_ConfigWebRequest_enumerateobjectsderivedfrom
object
2 properties 1 required
Core_WebSDK_ConfigWebResponse_enumerateobjectsderivedfrom
object
3 properties
Core_WebSDK_ConfigWebRequest_create
object
3 properties 2 required
Core_WebSDK_ConfigWebResponse_create
object
3 properties
Core_WebSDK_ConfigWebRequest_delete
object
3 properties
Core_WebSDK_ConfigWebResponse_delete
object
2 properties
Core_WebSDK_ConfigWebResponse_defaultdn
object
3 properties
Core_WebSDK_ConfigWebRequest_find
object
8 properties
Core_WebSDK_ConfigWebResponse_find
object
3 properties
Core_WebSDK_ConfigWebRequest_readall
object
2 properties
Core_WebSDK_ConfigWebResponse_readall
object
3 properties
Core_WebSDK_ConfigWebRequest_findcontainers
object
3 properties
Core_WebSDK_ConfigWebResponse_findcontainers
object
3 properties
Core_WebSDK_ConfigWebRequest_findobjectsofclass
object
6 properties
Core_WebSDK_ConfigWebResponse_findobjectsofclass
object
3 properties
Core_WebSDK_ConfigWebRequest_findpolicy
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_findpolicy
object
5 properties
Core_WebSDK_ConfigWebRequest_gethighestrevision
object
3 properties
Core_WebSDK_ConfigWebResponse_gethighestrevision
object
3 properties
Core_WebSDK_ConfigWebRequest_getrevision
object
2 properties
Core_WebSDK_ConfigWebResponse_getrevision
object
3 properties
Core_WebSDK_ConfigWebRequest_getobjecttrustees
object
1 property 1 required
Core_WebSDK_ConfigWebResponse_getobjecttrustees
object
3 properties
Core_WebSDK_ConfigWebRequest_guidtodn
object
1 property 1 required
Core_WebSDK_ConfigWebResponse_guidtodn
object
6 properties
Core_WebSDK_ConfigWebRequest_isvalid
object
3 properties
Core_WebSDK_ConfigWebResponse_isvalid
object
3 properties
Core_WebSDK_ConfigWebRequest_mutateobject
object
2 properties 2 required
Core_WebSDK_ConfigWebResponse_mutateobject
object
2 properties
Core_WebSDK_ConfigWebRequest_containableclasses
object
1 property 1 required
Core_WebSDK_ConfigWebResponse_containableclasses
object
3 properties
Core_WebSDK_ConfigWebRequest_dntoguid
object
1 property 1 required
Core_WebSDK_ConfigWebResponse_dntoguid
object
6 properties
Core_WebSDK_ConfigWebRequest_idinfo
object
1 property 1 required
Core_WebSDK_ConfigWebResponse_idinfo
object
7 properties
Core_WebSDK_ConfigWebRequest_renameobject
object
2 properties 2 required
Core_WebSDK_ConfigWebResponse_renameobject
object
2 properties
Core_WebSDK_ConfigWebRequest_clearattribute
object
3 properties 1 required
Core_WebSDK_ConfigWebResponse_clearattribute
object
2 properties
Core_WebSDK_ConfigWebRequest_clearpolicyattribute
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_clearpolicyattribute
object
2 properties
Core_WebSDK_ConfigWebRequest_read
object
3 properties 1 required
Core_WebSDK_ConfigWebResponse_read
object
3 properties
Core_WebSDK_ConfigWebRequest_countobjects
object
5 properties
Core_WebSDK_ConfigCountWebResponse
object
Response for a successful config request
2 properties
Core_WebSDK_ConfigWebRequest_readdn
object
3 properties 1 required
Core_WebSDK_ConfigWebResponse_readdn
object
3 properties
Core_WebSDK_ConfigWebRequest_readdnreferences
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_readdnreferences
object
3 properties
Core_WebSDK_ConfigWebRequest_readeffectivepolicy
object
3 properties 1 required
Core_WebSDK_ConfigWebResponse_readeffectivepolicy
object
6 properties
Core_WebSDK_ConfigWebRequest_readpolicy
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_readpolicy
object
4 properties
Core_WebSDK_ConfigWebRequest_addvalue
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_addvalue
object
2 properties
Core_WebSDK_ConfigWebRequest_adddnvalue
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_adddnvalue
object
2 properties
Core_WebSDK_ConfigWebRequest_addpolicyvalue
object
6 properties 3 required
Core_WebSDK_ConfigWebResponse_addpolicyvalue
object
2 properties
Core_WebSDK_ConfigWebRequest_removevalue
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_removevalue
object
2 properties
Core_WebSDK_ConfigWebRequest_removednvalue
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_removednvalue
object
2 properties
Core_WebSDK_ConfigWebRequest_removepolicyvalue
object
5 properties 3 required
Core_WebSDK_ConfigWebResponse_removepolicyvalue
object
2 properties
Core_WebSDK_ConfigWebRequest_write
object
5 properties
Core_WebSDK_ConfigWebResponse_write
object
2 properties
Core_WebSDK_ConfigWebRequest_writedn
object
4 properties 2 required
Core_WebSDK_ConfigWebResponse_writedn
object
2 properties
Core_WebSDK_ConfigWebRequest_writepolicy
object
6 properties 3 required
Core_WebSDK_ConfigWebResponse_writepolicy
object
2 properties
Core_WebSDK_ConfigWebSchemaRequest_classes
object
1 property
Core_WebSDK_ConfigWebResponse_classes
object
3 properties
Core_WebSDK_ConfigWebSchemaRequest_class
object
1 property
Core_WebSDK_ConfigWebResponse_class
object
3 properties
Core_WebSDK_ConfigWebResponse_attributes
object
3 properties
Core_WebSDK_ConfigWebSchemaRequest_attribute
object
1 property
Core_WebSDK_ConfigWebResponse_attribute
object
3 properties
Core_WebSDK_X509CertificateStoreWebRequest_add
object
2 properties 1 required
Core_WebSDK_X509CertificateStoreWebResponse
object
Represents a response from operations performed on the X.509 certificate store.
11 properties
Core_WebSDK_X509CertificateStoreWebResponse_add
object
3 properties
Core_WebSDK_X509CertificateStoreWebRequest_lookup
object
3 properties
Core_WebSDK_X509CertificateStoreWebResponse_lookup
object
3 properties
Core_WebSDK_X509CertificateStoreWebRequest_lookupexpiring
object
2 properties 2 required
Core_WebSDK_X509CertificateStoreWebResponse_lookupexpiring
object
2 properties
Core_WebSDK_X509CertificateStoreWebRequest_remove
object
2 properties 1 required
Core_WebSDK_X509CertificateStoreWebResponse_remove
object
1 property
Core_WebSDK_X509CertificateStoreWebRequest_retrieve
object
1 property 1 required
Core_WebSDK_X509CertificateStoreWebResponse_retrieve
object
1 property
Core_WebSDK_CredentialsWebRequest_create
object
9 properties 6 required
Core_WebSDK_CredentialsWebResponse_create
object
1 property
Core_WebSDK_CredentialsWebRequest_delete
object
1 property 1 required
Core_WebSDK_CredentialsWebResponse_delete
object
1 property
Core_WebSDK_CredentialsWebRequest_enumerate
object
3 properties 1 required
Core_WebSDK_CredentialsWebResponse_enumerate
object
2 properties
Core_WebSDK_CredentialsWebRequest_rename
object
2 properties 2 required
Core_WebSDK_CredentialsWebResponse_rename
object
1 property
Core_WebSDK_CredentialsWebRequest_retrieve
object
1 property 1 required
Core_WebSDK_CredentialsWebResponse_retrieve
object
9 properties
Core_WebSDK_CredentialsWebRequest_update
object
9 properties 6 required
Core_WebSDK_CredentialsWebResponse_update
object
1 property
Core_WebSDK_CryptoWebResponse_availablekeys
object
1 property
Core_WebSDK_CryptoWebResponse_defaultkey
object
1 property
Core_WebSDK_IdentityWebRequest_browse
object
4 properties
Core_WebSDK_IdentityWebResponse_browse
object
1 property
Core_WebSDK_IdentityWebRequest_getassociatedentries
object
1 property
Core_WebSDK_IdentityWebResponse_getassociatedentries
object
1 property
Core_WebSDK_IdentityWebRequest_getmembers
object
1 property
Core_WebSDK_IdentityWebResponse_getmembers
object
1 property
Core_WebSDK_IdentityWebRequest_getmemberships
object
1 property
Core_WebSDK_IdentityWebResponse_getmemberships
object
1 property
Core_WebSDK_IdentityWebRequest_readattribute
object
1 property
Core_WebSDK_IdentityWebResponse_readattribute
object
1 property
Core_WebSDK_IdentityWebRequest_validate
object
1 property
Core_WebSDK_IdentityWebResponse_validate
object
1 property
Core_WebSDK_IdentityWebResponse_self
object
1 property
Core_WebSDK_IdentityWebRequest_SetPassword
object
3 properties
Core_WebSDK_IdentityWebResponse_SetPassword
object
1 property
Core_WebSDK_IdentityWebRequest_addgroup
object
3 properties
Core_WebSDK_IdentityWebResponse_addgroup
object
2 properties
Core_WebSDK_IdentityWebRequest_renamegroup
object
2 properties
Core_WebSDK_IdentityWebResponse_renamegroup
object
1 property
Core_WebSDK_IdentityWebResponse_group__prefix___principal_
object
1 property
Core_WebSDK_IdentityWebRequest_addgroupmembers
object
2 properties
Core_WebSDK_IdentityWebResponse_addgroupmembers
object
2 properties
Core_WebSDK_IdentityWebRequest_removegroupmembers
object
3 properties
Core_WebSDK_IdentityWebResponse_removegroupmembers
object
3 properties
Core_WebSDK_MetadataWebRequest_set
object
3 properties 3 required
Core_WebSDK_MetadataWebResponse_set
object
2 properties
Core_WebSDK_MetadataWebRequest_setpolicy
object
4 properties 4 required
Core_WebSDK_MetadataWebResponse_setpolicy
object
3 properties
Core_WebSDK_MetadataWebRequest_get
object
2 properties 1 required
Core_WebSDK_MetadataWebResponse_get
object
3 properties
Core_WebSDK_MetadataWebRequest_readeffectivevalues
object
2 properties 2 required
Core_WebSDK_MetadataWebResponse_readeffectivevalues
object
6 properties
Core_WebSDK_MetadataWebRequest_readpolicy
object
3 properties 3 required
Core_WebSDK_MetadataWebResponse_readpolicy
object
4 properties
Core_WebSDK_MetadataWebRequest_getitems
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_getitems
object
3 properties
Core_WebSDK_MetadataWebRequest_getitemguids
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_getitemguids
object
3 properties
Core_WebSDK_MetadataWebRequest_getpolicyitems
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_getpolicyitems
object
3 properties
Core_WebSDK_MetadataWebRequest_getitemsforclass
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_getitemsforclass
object
3 properties
Core_WebSDK_MetadataWebRequest_find
object
2 properties
Core_WebSDK_MetadataWebResponse_find
object
3 properties
Core_WebSDK_MetadataWebRequest_defineitem
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_defineitem
object
4 properties
Core_WebSDK_MetadataWebRequest_undefineitem
object
2 properties 1 required
Core_WebSDK_MetadataWebResponse_undefineitem
object
2 properties
Core_WebSDK_MetadataWebRequest_finditem
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_finditem
object
3 properties
Core_WebSDK_MetadataWebRequest_loaditem
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_loaditem
object
3 properties
Core_WebSDK_MetadataWebRequest_loaditemguid
object
1 property 1 required
Core_WebSDK_MetadataWebResponse_loaditemguid
object
3 properties
Core_WebSDK_MetadataWebRequest_updateitem
object
2 properties
Core_WebSDK_MetadataWebResponse_updateitem
object
2 properties
Core_WebSDK_MetadataWebResponse_items
object
3 properties
Core_WebSDK_RightsWebRequest_grantsystemrole
object
2 properties
Core_WebSDK_RightsWebResponse_grantsystemrole
object
1 property
Core_WebSDK_RightsWebRequest_revokesystemrole
object
2 properties
Core_WebSDK_RightsWebResponse_revokesystemrole
object
1 property
Core_WebSDK_SecretStoreWebRequest_add
object
4 properties 5 required
Core_WebSDK_SecretStoreWebResponse_add
object
3 properties
Core_WebSDK_SecretStoreWebResponse_availablenamespaces
object
1 property
Core_WebSDK_SecretStoreWebRequest_associate
object
5 properties 2 required
Core_WebSDK_SecretStoreWebResponse_associate
object
2 properties
Core_WebSDK_SecretStoreWebRequest_dissociate
object
5 properties 1 required
Core_WebSDK_SecretStoreWebResponse_dissociate
object
2 properties
Core_WebSDK_SecretStoreWebResponse_encryptionkeysinuse
object
2 properties
Core_WebSDK_SecretStoreWebResponse_lookup
object
3 properties
Core_WebSDK_SecretStoreWebRequest_lookupbyvaulttype
object
1 property 1 required
Core_WebSDK_SecretStoreWebResponse_lookupbyvaulttype
object
3 properties
Core_WebSDK_SecretStoreWebRequest_lookupbyassociation
object
4 properties 1 required
Core_WebSDK_SecretStoreWebResponse_lookupbyassociation
object
3 properties
Core_WebSDK_SecretStoreWebRequest_lookupassociationbyvaultid
object
2 properties 2 required
Core_WebSDK_SecretStoreWebResponse_lookupassociationbyvaultid
object
3 properties
Core_WebSDK_SecretStoreWebRequest_lookupallassociationsbyvaultid
object
2 properties 1 required
Core_WebSDK_SecretStoreWebResponse_lookupallassociationsbyvaultid
object
3 properties
Core_WebSDK_SecretStoreWebRequest_mutate
object
5 properties 2 required
Core_WebSDK_SecretStoreWebResponse_mutate
object
2 properties
Core_WebSDK_SecretStoreWebRequest_lookupbyowner
object
3 properties 2 required
Core_WebSDK_SecretStoreWebResponse_lookupbyowner
object
3 properties
Core_WebSDK_SecretStoreWebRequest_owneradd
object
3 properties 3 required
Core_WebSDK_SecretStoreWebResponse_owneradd
object
2 properties
Core_WebSDK_SecretStoreWebRequest_ownerdelete
object
3 properties 2 required
Core_WebSDK_SecretStoreWebResponse_ownerdelete
object
2 properties
Core_WebSDK_SecretStoreWebRequest_ownerlookup
object
2 properties 2 required
Core_WebSDK_SecretStoreWebResponse_ownerlookup
object
3 properties
Core_WebSDK_SecretStoreWebRequest_retrieve
object
1 property 1 required
Core_WebSDK_SecretStoreWebResponse_retrieve
object
2 properties
Core_WebSDK_SecretStoreWebResponse_rotatekey__vaultid_
object
1 property
Core_WebSDK_WorkflowTicketsWebRequest_ticket_create
object
5 properties 5 required
Core_WebSDK_WorkflowTicketsWebResponse
object
14 properties
Core_WebSDK_WorkflowTicketsWebRequest_ticket_delete
object
1 property 1 required
Core_WebSDK_WorkflowTicketsWebRequest_ticket_details
object
1 property 1 required
Core_WebSDK_WorkflowTicketsWebRequest_ticket_enumerate
object
2 properties
Core_WebSDK_WorkflowTicketsWebRequest_ticket_exists
object
1 property 1 required
Core_WebSDK_WorkflowTicketsWebRequest_ticket_status
object
1 property 1 required
Core_WebSDK_WorkflowTicketsWebRequest_ticket_updatestatus
object
5 properties 2 required
Core_WebSDK_LogWebRequest_evaluatemacro
object
8 properties 2 required
Core_WebSDK_LogWebResponse_evaluatemacro
object
3 properties
WebSDK_Log_LogAdaptableResponse
object
Response for AdaptableInformation endpoint.
2 properties
Ssh_WebSDK_AuthRulesResponse
object
Result class containing list of key authorization rules as well as paging links and count information.
4 properties
Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest
object
Data object
8 properties
IList_1_Ssh_WebSDK_DataContract_TestDeviceConnectionResult_
array
Ssh_WebSDK_DataContract_Requests_KeyUsageData
object
The class for key usage request.
1 property
Ssh_WebSDK_DataContract_SshWebResponse
object
Contains the response information for arbitrary action.
3 properties
Ssh_WebSDK_DataContract_Requests_SshLoadDataRequest_KeyUsage
object
3 properties 3 required
Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshKeyUsageData_
object
Contains the response information for paginated queries.
1 property
Ssh_WebSDK_DataContract_Requests_KeyWebRequest
object
The class for key request.
1 property
Ssh_WebSDK_DataContract_Requests_KeySetWebRequest
object
The class for keyset request.
1 property
Ssh_WebSDK_DataContract_Requests_KeyOptionsWebRequest
object
The class for key options request.
5 properties
Ssh_WebSDK_DataContract_Requests_EditSelfServiceAuthorizedKeyWebRequest
object
The class for editing selfservice authorized key request.
6 properties
Ssh_WebSDK_DataContract_Requests_AddSelfServicePrivateKeyWebRequest
object
The class for adding selfservice private key request.
6 properties
Ssh_WebSDK_DataContract_AddSelfServiceKeyWebResponse
object
The class for adding selfservice private key response.
4 properties
Ssh_WebSDK_DataContract_Requests_AddSelfServiceAuthorizedKeyWebRequest
object
The class for adding selfservice authorized key request.
10 properties
Ssh_WebSDK_DataContract_Requests_KeysetToPolicyWebRequest
object
The class for keyset to policy migration.
3 properties
Ssh_WebSDK_DataContract_Requests_ExportSelfServiceKeyRequest
object
The class for exporting selfservice key request.
2 properties
Ssh_WebSDK_DataContract_ExportSelfServiceKeyResponse
object
The class for exporting selfservice key response.
2 properties
Ssh_WebSDK_DataContract_Requests_ExportSelfServicePrivateKeyRequest
object
The class for exporting selfservice key request.
3 properties
Ssh_WebSDK_DataContract_Requests_AddUserPrivateKeyWebRequest
object
The class for adding user private key request.
7 properties
Ssh_WebSDK_DataContract_AddUserPrivateKeyWebResponse
object
The class for adding user private key response.
3 properties
Ssh_WebSDK_DataContract_Requests_AddHostPrivateKeyWebRequest
object
The class for adding host private key request.
6 properties
Ssh_WebSDK_DataContract_AddHostPrivateKeyWebResponse
object
The class for adding host private key response.
3 properties
Ssh_WebSDK_DataContract_Requests_AddAuthorizedKeyWebRequest
object
The class for adding authorized key request.
10 properties
Ssh_WebSDK_DataContract_AddKeyWebResponse
object
The class for adding key response.
2 properties
Ssh_WebSDK_DataContract_Requests_AddKnownHostKeyWebRequest
object
The class for adding knownhost key request.
5 properties
Ssh_WebSDK_DataContract_Requests_AuthorizedKeyData
object
The class for importing authorized key request.
5 properties
Ssh_WebSDK_DataContract_ImportResponse
object
The class for importing key response.
2 properties
Ssh_WebSDK_DataContract_Requests_PrivateKeyData
object
The class for importing private key request.
6 properties
Ssh_WebSDK_DataContract_Requests_ChangePrivateKeyPassphraseRequest
object
To change parivate key passphrase
2 properties
Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetRequest
object
The class for working with unmatched encrypted keyset
2 properties
Ssh_WebSDK_DataContract_Requests_UnmatchedKeysetDeleteRequest
object
The class for working with a deletion of a unmatched encrypted keyset
1 property
IList_1_Ssh_WebSDK_DataContract_KeyData_
array
Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_SshDeviceData_
object
Contains the response information for paginated queries.
1 property
Ssh_WebSDK_DataContract_KeysetData
object
Stores detailed SSH keyset information.
15 properties
Ssh_WebSDK_DataContract_PageResponse_1_Ssh_WebSDK_DataContract_KeysetData_
object
Contains the response information for paginated queries.
1 property
Ssh_WebSDK_DataContract_Requests_WorkflowKeyOperationRequest
object
The class for workflow key operation request.
2 properties
SshCertificate_WebSDK_DataContract_Requests_RequestNewCertificateWebRequest
object
The class for new certificate request.
18 properties
SshCertificate_WebSDK_DataContract_RequestCertificateResponse
object
The class for requesting new certificate response.
4 properties
SshCertificate_WebSDK_DataContract_Requests_RetrieveCertificateWebRequest
object
The class for retrieve certificate request.
5 properties
SshCertificate_WebSDK_DataContract_RetrieveCertificateResponse
object
The class for retrieving certificate response.
11 properties
List_1_SshCertificate_WebSDK_DataContract_AvailableTemplateResponse_
array
SshCertificate_WebSDK_DataContract_Requests_RetrieveTemplateWebRequest
object
The class for retrieve template request.
3 properties
SshCertificate_WebSDK_DataContract_RetrieveTemplateResponse
object
The class for retrieving ssh certificate template response
14 properties
SshCertificate_WebSDK_DataContract_Requests_CreateNewCAKeypairWebRequest
object
The class for new CA keypair.
7 properties
SshCertificate_WebSDK_DataContract_CreateCaKeyPairResponse
object
The class for requesting new CaKeyPair response.
11 properties
Teams_WebSDK_TeamWebRequest
object
Class to pass when issuing a Team request.
10 properties
Teams_WebSDK_TeamWebRequest__
object
6 properties 6 required
Teams_WebSDK_TeamWebResponse
object
Class to pass when issuing a team request
9 properties
Teams_WebSDK_TeamWebRequest_addteammembers
object
2 properties 2 required
Teams_WebSDK_TeamWebRequest_removeteammembers
object
3 properties 3 required
Teams_WebSDK_TeamWebRequest_addteamowners
object
3 properties 3 required
Teams_WebSDK_TeamWebRequest_demoteteamowners
object
3 properties 3 required
Teams_WebSDK_TeamWebRequest_renameteam
object
2 properties 2 required
Platform_WebSDK_PlatformWebRequest
object
Class to represent a Platform request for the WebSDK
1 property
Platform_WebSDK_PlatformWebResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

venafi-trust-protection-foundation-websdk-openapi.yml Raw ↑

Other APIs Venafi publishes across the network.

Certificate Manager - SaaS API (Venafi Control Plane)
Where this information came from

This is an independent, third-party profile of Trust Protection Foundation WebSDK (Venafi Trust Protection Platform), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.