pyVenafi Logo
  • Installation
    • Requirements
    • Installation
    • Uninstallation
  • Venafi Cloud
    • Authentication
    • Making API Calls
    • Logging
  • Venafi TPP
    • Requirements
    • Usage Guide
      • Authentication
      • The API Layer
        • Making API Calls
        • Using Models As Inputs
        • Oops, I Didn’t Get What I Expected!
      • The Features Layer
      • Common Terminology
      • Config And Identity Objects
      • Attribute, AttributeValues, and Class Names
      • Type Hinting
      • Logging
      • Parameter Interchangeability
    • Examples
      • Application
        • Application Types
        • Creating & Deleting Applications
        • Enabling & Disabling Applications
        • Getting Application Certificate
        • Getting Processing Stage & Status
        • Installing A Certificate To An Application
      • Authentication
        • Defining The OAuth API Application Integration
        • Username/Password Authentication
        • Certificate Authentication
        • Reusing An OAuth Token
        • Using A Proxy Server
      • Certificate
        • Creating & Deleting Certiifcate Objects
        • Listing Certificates
        • Renewing & Downloading A Certificate
        • Revoking A Certificate
        • Resetting & Retrying Certificate Requests
        • File & SSL Validation
        • Getting Certificate Data
        • Associating/Dissociating A Certificate
        • Handling Workflows
      • Certificate Authority
        • Certificate Authority Types
        • Creating & Deleting A Certificate Authority
      • Client Group
        • Client Group Types
        • Creating & Deleting A Client Group
        • Assigning & Removing Client Work
        • Listing All Client Groups
      • Client Work
        • Client Work Types
        • Creating & Deleting Client Work
        • Scheduling & Unscheduling Client Work
        • Enabling & Disabling Client Work
        • Listing All Client Work By Type
      • Code Signing
        • Applications
          • Managing Applications
          • Getting & Enumerating Applications
          • Find Application References
        • Application Collections
          • Managing Application Collections
          • Getting & Enumerating Application Collections
          • Find Application Collection References
        • Auditing
          • Retrieving Archive Entries
        • CodeSign
          • Applications
            • Managing Applications
            • Getting & Enumerating Applications
            • Find Application References
          • Application Collections
            • Managing Application Collections
            • Getting & Enumerating Application Collections
            • Find Application Collection References
          • Auditing
            • Retrieving Archive Entries
          • Environments
            • Managing Environments
            • Getting Environments
          • Global Configuration
            • Getting the Global Configuration
            • Setting the Global Configuration
          • Projects
            • Managing Projects
            • Getting & Enumerating Projects
          • Rights
            • Adding CodeSign Rights
            • Getting CodeSign Rights
          • Templates
            • Managing Templates
            • Getting & Enumerating Templates
        • Environments
          • Managing Environments
          • Getting Environments
        • Global Configuration
          • Getting the Global Configuration
          • Setting the Global Configuration
        • Projects
          • Managing Projects
          • Getting & Enumerating Projects
        • Rights
          • Adding CodeSign Rights
          • Getting CodeSign Rights
        • Templates
          • Managing Templates
          • Getting & Enumerating Templates
      • Credential
        • Credential Types
        • Creating & Deleting A Credential
        • Creating A Google Credential
      • Custom Field
        • Creating Custom Fields
        • Reading Custom Fields
        • Writing Custom Fields
      • Device
        • Creating And Deleting A Device
        • Scanning A Device For SSH Keys
      • Discovery And Placement
        • Managing Placement Rules
        • Network Discovery
          • Creating & Deleting Jobs
          • Scheduling, Unscheduling, And Blacking Out Jobs
          • Running, Pausing, And Cancelling Jobs
        • Onboard Discovery
          • Creating & Deleting Jobs
          • Scheduling And Unscheduling Jobs
          • Running, Pausing, And Cancelling Jobs
      • Folder
        • Creating And Deleting A Folder
        • Getting, Adding And Removing Engines
        • Applying And Removing Workflows
        • Searching Objects
        • Managing Policies
      • Identity
        • Users
          • Creating & Deleting Users
          • Changing User Passwords
          • Searching Users
          • Getting Memberships
        • Groups
          • Creating & Deleting Groups
          • Adding, Getting, & Removing Members
          • Searching Users
          • Getting Memberships
          • Renaming Groups
      • Object Management
        • Getting & Validating Config Objects
        • Reading Attributes
        • Writing Attributes
        • Waiting For Attribute Values
        • Renaming Objects
      • Permissions
        • Creating, Updating, & Deleting Permissions
        • Getting Explicit Permissions
        • Getting Implicit Permissions
        • Getting Effective Permissions
        • Listing Identities Permitted On An Object
      • Platforms
        • Platform Types
        • Updating Platform Compmonents
        • Getting The Platforms Root
      • Workflows And Tickets
        • Creating, Applying, & Deleting A Standard Workflow
        • Creating, Applying, & Deleting An Adaptable Workflow
        • Managing Workflow Tickets
          • Creating, Getting, & Deleting A Workflow Ticket
          • Getting All Workflow Tickets Pending My Approval
          • Approving And Rejecting Workflow Tickets
        • Creating & Deleting Reason Codes
      • CodeSign
        • Applications
          • Managing Applications
          • Getting & Enumerating Applications
          • Find Application References
        • Application Collections
          • Managing Application Collections
          • Getting & Enumerating Application Collections
          • Find Application Collection References
        • Auditing
          • Retrieving Archive Entries
        • Environments
          • Managing Environments
          • Getting Environments
        • Global Configuration
          • Getting the Global Configuration
          • Setting the Global Configuration
        • Projects
          • Managing Projects
          • Getting & Enumerating Projects
        • Rights
          • Adding CodeSign Rights
          • Getting CodeSign Rights
        • Templates
          • Managing Templates
          • Getting & Enumerating Templates
    • API Reference
      • Features
        • Application
          • Adaptable Application
          • Amazon AWS
          • Apache
          • Apache Group
          • Azure Key Vault
          • Basic Application
          • Blue Coat SSLVA
          • CAPI
          • Citrix NetScaler
          • Connect:Direct
          • F5 Authentication Bundle
          • F5 LTM Advanced
          • Google Cloud Load Balancer
          • IBM DataPower
          • IBM GSK
          • Imperva MX
          • JKS
          • Oracle iPlanet
          • PEM
          • PKCS11
          • PKCS11 Group
          • PKCS #12
          • Palo Alto Network FW
          • Riverbed Steelhead
          • Tealeaf PCA
          • VAM nShield
        • Certificate
        • Certificate Authorities
          • Self-Signed CA
          • Microsoft CA
          • Self-Signed CA
        • Client Groups
          • Agentless Group
          • EST Certificate Enrollment Group
          • Venafi Agent Group
        • Client Work
          • Agent Connectivity
          • Agent Upgrade
          • Certificate Device Placement
          • Certificate Discovery
          • Certificate Enrollment Via EST Protocol
          • Certificate Installation
          • Device Certificate Creation
          • Dynamic Provisioning
          • SSH Device Placement
          • SSH Discovery
          • SSH Key Usage
          • SSH Remediation
          • User Certificate Creation
        • Codesign
          • Codesign Application
            • Application
            • Application Collection
          • Auditing
          • Environment
          • Global Configuration
          • Project
          • Rights
          • Template
        • Credentials
          • Amazon Credential
          • Certificate Credential
          • Generic Credential
          • Google Credential
          • Password Credential
          • Private Key Credential
          • Username/Password Credential
        • Custom Field
        • Device
          • Device
          • Jump Server
        • Discovery
          • Adaptable Onboard Discovery
          • AWS Onboard Discovery
          • Azure Onboard Discovery
          • CAPI Onboard Discovery
          • F5 LTM Advanced Onboard Discovery
          • IBM DataPower Onboard Discovery
          • Citrix NetScaler Onboard Discovery
          • Network Discovery
        • Folder
        • Identity
          • Group
          • User
        • Objects
        • Permissions
        • Placement Rules
          • Placement Rule Condition
          • Placement Rules
        • Platforms
          • Auto Layout Manager
          • Bulk Provisioning Manager
          • CA Import Manager
          • Certificate Manager
          • Certificate Pre-Enrollment
          • Certificate Revocation
          • Cloud Instance Monitor
          • Discovery Manager
          • Key Manager
          • Monitor
          • Onboard Discovery Manager
          • Platforms
          • Reporting
          • SSH Certificate Manager
          • SSH Manager
          • TrustNet Manager
          • Validation Manager
        • Workflow
          • Adaptable Workflow
          • Reason Code
          • Standard Workflow
          • Ticket
      • API
        • API Base Class
        • Authenticate
        • API Session Class
          • Session
            • Session.delete()
            • Session.get()
            • Session.post()
            • Session.put()
            • Session.update_headers()
        • WebSDK API
      • Models
        • Certificate
          • BitMaskValues
          • CSR
          • CSRDetails
          • Certificate
          • CertificateDetails
          • CertificateFilter
          • Compliant
          • CompliantMultiValue
          • CompliantSingleValue
          • File
          • Link
          • Locked
          • LockedKeyPair
          • LockedMultiValue
          • LockedSingleValue
          • LockedSubject
          • NameTypeValue
          • NameValue
          • Policy
          • PreviousVersions
          • ProcessingDetails
          • RenewalDetails
          • SANS
          • SslTls
          • SslTlsResult
          • ValidationDetails
          • X509
        • Resultcodes
        • Client
          • Client
          • ClientDetails
          • Network
          • Result
          • Work
        • Codesign
          • AppleEnvironment
          • AppleTemplate
          • Application
          • ApplicationCollection
          • ArchiveFilter
          • ArchiveResults
          • CSPEnvironment
          • CSPTemplate
          • CertificateEnvironment
          • CertificateEnvironment_Pre22_4
          • CertificateTemplate
          • CustomFieldAttributes
          • DotNetEnvironment
          • DotNetTemplate
          • EnvironmentTemplateDetails
          • GPGEnvironment
          • GPGTemplate
          • GlobalConfiguration
          • InfoValue
          • Items
          • KeyPairEnvironment
          • KeyPairTemplate
          • Project
          • ResultCode
          • Rights
          • RightsKeyValue
          • SignApplicationCollection
        • Config
          • AttributeDefinition
          • ClassDefinition
          • NameAttribute
          • NameValues
          • Object
          • Policy
          • Result
        • Config Schema
          • AttributeDefinition
          • ClassDefinition
          • Result
        • Credential
          • CredentialInfo
          • NameTypeValue
          • Result
        • Discovery
          • Certificate
          • Endpoint
          • Protocol
        • Flow
          • Approval
          • KeyValue
          • Result
          • Ticket
        • Hsm Api
          • Certificate
          • ClientInfo
          • Parameter
          • PrivateKey
          • ProcessInfo
          • PublicKey
        • Identity
          • Identity
          • InvalidIdentity
        • Log
          • Field
          • LogEvent
          • LogEventApplicationDefinition
          • LogEventDefinition
          • Script
        • Metadata
          • Data
          • GuidData
          • Item
          • NameValue
          • PolicyItem
          • Result
          • Update
        • Oauth
          • Application
          • CertificateConfiguration
          • Configuration
          • DeviceConfiguration
          • Grant
          • JwtMapping
          • OwnedApplication
          • Permissions
          • Role
          • Rule
          • Scope
        • Permissions
          • Permissions
        • Pki
          • Certificate
          • Installation
          • PKI
          • SANS
        • Preferences
          • Preference
        • Processing Engines
          • Engine
          • Folder
          • Link
          • Self
        • Recycle Bin
          • Deletion
          • Detail
          • Identity
          • Item
          • Purge
          • Result
        • Secret Store
          • Result
          • TypedNameValues
        • Ssh
          • ConnectionResult
          • DeviceData
          • KeyData
          • KeySetData
          • KeySetFilter
          • KeyUsageData
          • KeyUsageFilter
          • LogData
          • SshDeviceFilter
          • SshWebResponse
        • Ssh Certificates
          • APIClient
          • AccessControl
          • AvailableTemplate
          • CAKeyPair
          • Certificate
          • CertificateDetails
          • Output
          • ProcessingDetails
          • RequestDetails
        • Stats
          • Counter
          • CounterContainer
          • Key
          • Result
          • Value
        • System Status
          • Engine
          • IisService
          • LogServerService
          • Services
          • SystemStatus
          • Task
          • UpgradeInfo
          • UpgradeStatus
          • UpgradeSummary
          • vPlatformService
        • Workflow
          • Details
          • Result
        • Bus Status
          • AdditionalProp
          • AdditionalPropStatus
          • Status
pyVenafi
  • Search

© Copyright 2026, Venafi.

Built with Sphinx using a theme provided by Read the Docs.