PyTPP Logo
stable

Table Of Contents

  • Usage Guide
    • Authentication
    • The API Layer
    • 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
    • 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
    • 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
  • 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
        • 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
      • Credentials
        • Amazon Credential
        • Certificate Credential
        • Generic Credential
        • Google Credential
        • Password Credential
        • Private Key Credential
        • Username/Password Credential
      • Custom Field
      • Device
        • Device
        • Jump Server
      • 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
        • Monitor
        • Onboard Discovery Manager
        • Platforms
        • Reporting
        • SSH Manager
        • TrustNet Manager
        • Validation Manager
      • Workflow
        • Adapatable Workflow
        • Reason Code
        • Standard Workflow
        • Ticket
    • API
      • API Base Class
      • Authenticate
      • API Session Class
      • WebSDK API
    • Dataclasses
      • Certificate
      • Client
      • Codesign
      • Config
      • Config Schema
      • Credential
      • Flow
      • Identity
      • Log
      • Metadata
      • Permissions
      • Pki
      • Preferences
      • Processing Engines
      • Secret Store
      • Ssh
      • Ssh Certificates
      • Stats
      • System Status
      • Worfklow
PyTPP
  • »
  • API Reference »
  • API
  • Edit on GitHub
Previous Next

API

  • API Base Class
  • Authenticate
  • API Session Class
  • WebSDK API
Previous Next

© Copyright 2022, Venafi. Revision 37b05045.

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