Skip to content

README.md

Latest commit

 

History

History
958 lines (926 loc) · 131 KB

README.md

File metadata and controls

958 lines (926 loc) · 131 KB
Raw

Go API client for Keyfactor Command (API Version V1)

This page provides a utility through which the Keyfactor API endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow development. It also serves secondarily as documentation for the API.

If you would like to view documentation containing details on the Keyfactor API and endpoints, please refer to the Web API section of the Keyfactor Command documentation.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • Keyfactor Command API Version: 24.4.2
  • API version: 1
  • Package version: 1.0.0
  • OpenAPI Generator Version: 7.12.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

For more information on the Keyfactor Command API Documentation, please visit here.

For more information on OpenAPI Generator, please visit its documentation.

Installation

Install the following dependencies:

go get "github.com/Keyfactor/keyfactor-go-client-sdk/v24"

Put the package under your project folder and add the following in import:

import "github.com/Keyfactor/keyfactor-go-client-sdk/v24/api/keyfactor/v1"

Configuration

Configuration of the API client is done through the github.com/Keyfactor/keyfactor-auth-client-go/auth_providers Go package.

Here is an example of configuring your API client:

import (
	"os"
	"github.com/Keyfactor/keyfactor-auth-client-go/auth_providers"
	"github.com/Keyfactor/keyfactor-go-client-sdk/v24/api/keyfactor/v1"
)

hostname := os.Getenv(auth_providers.EnvKeyfactorHostName)
apiPath := os.Getenv(auth_providers.EnvKeyfactorAPIPath)

clientId := os.Getenv(auth_providers.EnvKeyfactorClientID)
clientSecret := os.Getenv(auth_providers.EnvKeyfactorClientSecret)
tokenUrl := os.Getenv(auth_providers.EnvKeyfactorAuthTokenURL)

oAuthNoParamsConfig := auth_providers.CommandConfigOauth{}
oAuthNoParamsConfig.CommandAuthConfig.
	WithCommandHostName(hostname).
	WithCommandAPIPath(apiPath).
	WithSkipVerify(false).
	WithClientTimeout(10)
oAuthNoParamsConfig.
	WithClientId(clientId).
	WithClientSecret(clientSecret).
	WithTokenUrl(tokenUrl).
	Authenticate()

// Configure API client
client, err := keyfactor.NewAPIClient(oAuthNoParamsConfig.GetServerConfig())

Documentation for API Endpoints

All URIs are relative to http://keyfactor.example.com

Class Method HTTP request Description
AgentApi CreateAgentsApprove Post /Agents/Approve Approve a list of agents
AgentApi CreateAgentsByIdFetchLogs Post /Agents/{id}/FetchLogs Schedules a job on the agent to retrieve log files
AgentApi CreateAgentsByIdReset Post /Agents/{id}/Reset Reset an agent to a new state
AgentApi CreateAgentsDisapprove Post /Agents/Disapprove Disapprove a list of agents
AgentApi CreateAgentsReset Post /Agents/Reset Reset a list of agents
AgentApi CreateAgentsSetAuthCertificateReenrollment Post /Agents/SetAuthCertificateReenrollment Update the AuthCertificateReenrollment value for an agent to request or require (or unset the request) the agent to enroll for a new client authentication certificate on its next registration.
AgentApi DeleteAgentsById Delete /Agents/{id} Delete a single agent, specified by ID
AgentApi GetAgents Get /Agents Returns all agents according to the provided filter and output parameters
AgentApi GetAgentsById Get /Agents/{id} Returns details for a single agent, specified by ID
AgentBlueprintApi CreateAgentBluePrintApplyBlueprint Post /AgentBluePrint/ApplyBlueprint Applies the selected agent blueprint to the provided agents
AgentBlueprintApi CreateAgentBluePrintGenerateBluePrint Post /AgentBluePrint/GenerateBluePrint Generates an agent blueprint from the provided agents
AgentBlueprintApi DeleteAgentBluePrintById Delete /AgentBluePrint/{id} Deletes an agent blueprint by its Keyfactor identifier
AgentBlueprintApi GetAgentBluePrint Get /AgentBluePrint Returns all agent blueprints according to the provided filter and output parameters
AgentBlueprintApi GetAgentBluePrintById Get /AgentBluePrint/{id} Returns an agent blueprint according to the provided filter and output parameters
AgentBlueprintApi GetAgentBluePrintByIdJobs Get /AgentBluePrint/{id}/Jobs Gets the agent blueprint scheduled jobs
AgentBlueprintApi GetAgentBluePrintByIdStores Get /AgentBluePrint/{id}/Stores Gets the agent blueprint certificate stores
AgentPoolApi CreateAgentPools Post /AgentPools Creates an agent pool with the provided properties
AgentPoolApi DeleteAgentPoolsById Delete /AgentPools/{id} Deletes the agent pool associated with the provided id
AgentPoolApi GetAgentPools Get /AgentPools Returns all agent pools according to the provided filter and output parameters
AgentPoolApi GetAgentPoolsAgents Get /AgentPools/Agents Returns all agents for the default agent pool
AgentPoolApi GetAgentPoolsById Get /AgentPools/{id} Returns a single agent pool associated with the provided id
AgentPoolApi UpdateAgentPools Put /AgentPools Updates an existing agent pool with the provided properties
AppSettingApi GetAppSetting Get /AppSetting Get available application settings
AppSettingApi GetAppSettingById Get /AppSetting/{id} Get application setting by id
AppSettingApi UpdateAppSetting Put /AppSetting Bulk update available application settings
AppSettingApi UpdateAppSettingByIdSet Put /AppSetting/{id}/Set Update one application setting by id
AppSettingApi UpdateAppSettingNameSet Put /AppSetting/{name}/Set Update one application setting by short name
AuditLogApi GetAudit Get /Audit Returns all audit log entries according to the provided filter and output parameters
AuditLogApi GetAuditById Get /Audit/{id} Returns the audit log entry associated with the provided identifier
AuditLogApi GetAuditByIdValidate Get /Audit/{id}/Validate Validates the audit log entry associated with the provided keyfactor id
AuditLogApi GetAuditDownload Get /Audit/Download Returns a Comma Separated file containing the audit log entries according to the provided filter
AuditLogApi GetAuditRelatedEntities Get /Audit/RelatedEntities Returns the audit log entry associated with the provided keyfactor id
CAConnectorApi CreateCertificateAuthorityCAConnectors Post /CertificateAuthority/CAConnectors Creates a new CA Connector object
CAConnectorApi DeleteCertificateAuthorityCAConnectorsById Delete /CertificateAuthority/CAConnectors/{id} Deletes a CA Connector with the specific ID
CAConnectorApi GetCertificateAuthorityCAConnectors Get /CertificateAuthority/CAConnectors Returns all CA Connectors
CAConnectorApi GetCertificateAuthorityCAConnectorsById Get /CertificateAuthority/CAConnectors/{id} Returns a CA Connector with the specific ID
CAConnectorApi UpdateCertificateAuthorityCAConnectorsById Put /CertificateAuthority/CAConnectors/{id} Updates an existing CA Connector
CSRGenerationApi CreateCSRGenerationGenerate Post /CSRGeneration/Generate Generates a CSR according the properties provided
CSRGenerationApi DeleteCSRGenerationPending Delete /CSRGeneration/Pending Deletes the CSRs associated with the provided identifiers
CSRGenerationApi DeleteCSRGenerationPendingById Delete /CSRGeneration/Pending/{id} Deletes a CSR associated with the provided identifier
CSRGenerationApi GetCSRGenerationPending Get /CSRGeneration/Pending Returns a list of the currently pending CSRs according to the provided query
CSRGenerationApi GetCSRGenerationPendingById Get /CSRGeneration/Pending/{id} Returns a previously generated CSR associated with the provided identifier
CertificateApi CreateCertificatesAnalyze Post /Certificates/Analyze Returns the public information of the certificate
CertificateApi CreateCertificatesDownload Post /Certificates/Download Downloads the persisted certificate associated with the provided query
CertificateApi CreateCertificatesImport Post /Certificates/Import Imports the provided certificate into the Keyfactor instance, including any provided associated data
CertificateApi CreateCertificatesRecover Post /Certificates/Recover Recovers the persisted certificate associated with the provided query
CertificateApi CreateCertificatesRevoke Post /Certificates/Revoke Revokes the certificates associated with the provided identifiers and associates the provided data with the revocation
CertificateApi DeleteCertificates Delete /Certificates Deletes multiple persisted certificates by their unique ids
CertificateApi DeleteCertificatesById Delete /Certificates/{id} Deletes a persisted certificate by its unique id as well as the stored private key (if present) associated with it
CertificateApi DeleteCertificatesPrivateKey Delete /Certificates/PrivateKey Deletes the persisted private keys of multiple certificates by the unique ids of the Certificates
CertificateApi DeleteCertificatesPrivateKeyById Delete /Certificates/PrivateKey/{id} Deletes the persisted private keys of the certificate associated with the provided identifier
CertificateApi DeleteCertificatesQuery Delete /Certificates/Query Deletes multiple persisted certificate entities selected by a given query
CertificateApi GetCertificates Get /Certificates Returns all certificates according to the provided filter and output parameters
CertificateApi GetCertificatesById Get /Certificates/{id} Returns a single certificate that matches the id
CertificateApi GetCertificatesByIdHistory Get /Certificates/{id}/History Gets the history of operations on a certificate
CertificateApi GetCertificatesByIdSecurity Get /Certificates/{id}/Security Gets the list of Security Identities and which permissions they have on the given certificate.
CertificateApi GetCertificatesByIdValidate Get /Certificates/{id}/Validate Validates the certificate chain can be built.
CertificateApi GetCertificatesCSV Get /Certificates/CSV Returns a comma-delimited CSV file containing all certificates in the database
CertificateApi GetCertificatesIdentityAuditById Get /Certificates/IdentityAudit/{id} Audit identity permissions for certificate
CertificateApi GetCertificatesLocationsById Get /Certificates/Locations/{id} Returns a list of locations the certificate is in
CertificateApi GetCertificatesMetadataCompare Get /Certificates/Metadata/Compare Compares the metadata value provided with the metadata value associated with the specified certificate
CertificateApi UpdateCertificatesByIdOwner Put /Certificates/{id}/Owner Changes the certificate's owner. Users must be in the current owner's role and the new owner's role
CertificateApi UpdateCertificatesMetadata Put /Certificates/Metadata Updates the metadata for the certificate associated with the identifier provided
CertificateApi UpdateCertificatesMetadataAll Put /Certificates/Metadata/All Updates the metadata for certificates associated with the certificate identifiers or query provided
CertificateAuthorityApi CreateCertificateAuthority Post /CertificateAuthority Creates a new CertificateAuthority object
CertificateAuthorityApi CreateCertificateAuthorityAlertRecipientsCAHealthRecipients Post /CertificateAuthority/AlertRecipients/CAHealthRecipients Creates CA health monitoring recipients for the provided list of email addresses"
CertificateAuthorityApi CreateCertificateAuthorityAlertRecipientsCAThresholdRecipients Post /CertificateAuthority/AlertRecipients/CAThresholdRecipients Creates CA threshold alert recipients for the provided list of emails
CertificateAuthorityApi CreateCertificateAuthorityImport Post /CertificateAuthority/Import Imports any certificate authorities from the provided configuration tenant DNS
CertificateAuthorityApi CreateCertificateAuthorityPublishCRL Post /CertificateAuthority/PublishCRL Publishes a CRL according to the provided request
CertificateAuthorityApi CreateCertificateAuthorityTaskQueueTest Post /CertificateAuthority/TaskQueue/Test Tests the connection info for the TaskQueue Credentials.
CertificateAuthorityApi CreateCertificateAuthorityTest Post /CertificateAuthority/Test Validates the connection info for the CA provided by the model.
CertificateAuthorityApi DeleteCertificateAuthorityAlertRecipientsCAHealthRecipientsById Delete /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Deletes a CA health recipient for the provided ID
CertificateAuthorityApi DeleteCertificateAuthorityAlertRecipientsCAThresholdRecipientsById Delete /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Deletes a CA threshold recipient for the provided ID
CertificateAuthorityApi DeleteCertificateAuthorityById Delete /CertificateAuthority/{id} Deletes a CertificateAuthority from the system, specified by ID
CertificateAuthorityApi GetCertificateAuthority Get /CertificateAuthority Returns all certificate authorities according to the provided filter
CertificateAuthorityApi GetCertificateAuthorityAlertRecipientsCAHealthRecipients Get /CertificateAuthority/AlertRecipients/CAHealthRecipients Returns a list of all CA health recipients
CertificateAuthorityApi GetCertificateAuthorityAlertRecipientsCAHealthRecipientsById Get /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Returns a CA health recipient for the specified health recipient ID
CertificateAuthorityApi GetCertificateAuthorityAlertRecipientsCAThresholdRecipients Get /CertificateAuthority/AlertRecipients/CAThresholdRecipients Returns a list of all CA threshold recipients
CertificateAuthorityApi GetCertificateAuthorityAlertRecipientsCAThresholdRecipientsById Get /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Returns a CA threshold recipient for the specified threshold alert recipient ID
CertificateAuthorityApi GetCertificateAuthorityAvailableForests Get /CertificateAuthority/AvailableForests Returns a list of available forests that are in active directory
CertificateAuthorityApi GetCertificateAuthorityById Get /CertificateAuthority/{id} Returns details for a single CA, specified by ID
CertificateAuthorityApi GetCertificateAuthorityHealthMonitoringSchedule Get /CertificateAuthority/HealthMonitoring/Schedule Retrieves the execution schedule for the CA health monitoring job
CertificateAuthorityApi GetCertificateAuthoritySourceCount Get /CertificateAuthority/SourceCount Returns a count of certificate authorities with sync enabled
CertificateAuthorityApi GetCertificateAuthorityTaskQueue Get /CertificateAuthority/TaskQueue Retrieves credentials and connection information
CertificateAuthorityApi UpdateCertificateAuthority Put /CertificateAuthority Updates a CertificateAuthority object
CertificateAuthorityApi UpdateCertificateAuthorityAlertRecipientsCAHealthRecipientsById Put /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Updates a CA health alert recipient for the provided request object
CertificateAuthorityApi UpdateCertificateAuthorityAlertRecipientsCAThresholdRecipientsById Put /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Updates a CA threshold alert recipient for the provided request object
CertificateAuthorityApi UpdateCertificateAuthorityTaskQueue Put /CertificateAuthority/TaskQueue Updates credentials and connection information
CertificateCollectionApi CreateCertificateCollections Post /CertificateCollections Creates a new certificate collection with the provided properties
CertificateCollectionApi CreateCertificateCollectionsCopy Post /CertificateCollections/Copy Creates a new certificate collection from an existing collection. The permissions, query and description of the existing collection are copied when creating the new record, with the option to overwrite the query or description.
CertificateCollectionApi DeleteCertificateCollectionsById Delete /CertificateCollections/{id} Delete one certificate collection
CertificateCollectionApi GetCertificateCollections Get /CertificateCollections Returns all certificate collections
CertificateCollectionApi GetCertificateCollectionsById Get /CertificateCollections/{id} Returns the certificate collection definition associated with the provided Keyfactor identifier
CertificateCollectionApi GetCertificateCollectionsCollectionList Get /CertificateCollections/CollectionList Get certificate collection list with duplication field name
CertificateCollectionApi GetCertificateCollectionsCollectionOrdering Get /CertificateCollections/CollectionOrdering Returns an array of collection Id's where the index in the array represents the collection ordering
CertificateCollectionApi GetCertificateCollectionsLastEstimated Get /CertificateCollections/LastEstimated Get the last time the timer service ran the job to process certificates in collections
CertificateCollectionApi GetCertificateCollectionsName Get /CertificateCollections/{name} Returns the certificate collection associated with the provided collection name
CertificateCollectionApi GetCertificateCollectionsNavItems Get /CertificateCollections/NavItems Get the list of navigation items for certificate collection
CertificateCollectionApi UpdateCertificateCollections Put /CertificateCollections Updates an existing certificate collection with the provided properties
CertificateCollectionApi UpdateCertificateCollectionsByIdFavorite Put /CertificateCollections/{id}/Favorite Update favorite for one collection
CertificateStoreApi CreateCertificateStores Post /CertificateStores Creates a new certificate store with the provided properties
CertificateStoreApi CreateCertificateStoresApprove Post /CertificateStores/Approve Approves the provided certificate stores to make them available for management
CertificateStoreApi CreateCertificateStoresCertificatesAdd Post /CertificateStores/Certificates/Add Configures a management job to add a certificate to one or more stores with the provided schedule
CertificateStoreApi CreateCertificateStoresCertificatesRemove Post /CertificateStores/Certificates/Remove Configures a management job to remove a certificate from one or more stores with the provided schedule
CertificateStoreApi CreateCertificateStoresReenrollment Post /CertificateStores/Reenrollment Schedules a certificate store for reenrollment
CertificateStoreApi CreateCertificateStoresSchedule Post /CertificateStores/Schedule Creates an inventory schedule for the provided certificate stores
CertificateStoreApi DeleteCertificateStores Delete /CertificateStores Deletes multiple persisted certificate store entities by their identifiers
CertificateStoreApi DeleteCertificateStoresById Delete /CertificateStores/{id} Deletes a persisted certificate store by its Keyfactor identifier
CertificateStoreApi GetCertificateStores Get /CertificateStores Returns all certificate stores according to the provided filter and output parameters
CertificateStoreApi GetCertificateStoresById Get /CertificateStores/{id} Returns a single certificate store associated with the provided id
CertificateStoreApi GetCertificateStoresByIdInventory Get /CertificateStores/{id}/Inventory Returns a single certificate store's inventory associated with the provided id
CertificateStoreApi UpdateCertificateStores Put /CertificateStores Updates a given certificate store with the properties of the provided instance
CertificateStoreApi UpdateCertificateStoresAssignContainer Put /CertificateStores/AssignContainer Assigns the provided certificate stores to the provided container
CertificateStoreApi UpdateCertificateStoresDiscoveryJob Put /CertificateStores/DiscoveryJob Configures a discovery job to locate currently unmanaged certificate stores
CertificateStoreApi UpdateCertificateStoresPassword Put /CertificateStores/Password Sets a password for the requested certificate store
CertificateStoreContainerApi CreateCertificateStoreContainers Post /CertificateStoreContainers Add a certificate store container
CertificateStoreContainerApi DeleteCertificateStoreContainersById Delete /CertificateStoreContainers/{id} Delete a certificate store container
CertificateStoreContainerApi GetCertificateStoreContainers Get /CertificateStoreContainers Returns all certificate store container according to the provided filter and output parameters
CertificateStoreContainerApi GetCertificateStoreContainersById Get /CertificateStoreContainers/{id} Returns a single certificate store container that matches id
CertificateStoreContainerApi UpdateCertificateStoreContainers Put /CertificateStoreContainers Edit a certificate store container
CertificateStoreTypeApi CreateCertificateStoreTypes Post /CertificateStoreTypes Creates a new certificate store type with the provided properties
CertificateStoreTypeApi DeleteCertificateStoreTypes Delete /CertificateStoreTypes Deletes certificate store types according to the provided identifiers
CertificateStoreTypeApi DeleteCertificateStoreTypesById Delete /CertificateStoreTypes/{id} Deletes a certificate store type according to the provided identifier
CertificateStoreTypeApi GetCertificateStoreTypes Get /CertificateStoreTypes Returns all certificate store types according to the provided filter and output parameters
CertificateStoreTypeApi GetCertificateStoreTypesById Get /CertificateStoreTypes/{id} Returns a single certificate store type that matches id
CertificateStoreTypeApi GetCertificateStoreTypesNameName Get /CertificateStoreTypes/Name/{name} Returns a single certificate store type that matches the provided short name
CertificateStoreTypeApi UpdateCertificateStoreTypes Put /CertificateStoreTypes Updates an existing certificate store type with the provided properties
ComponentInstallationApi DeleteComponentInstallationById Delete /ComponentInstallation/{id} Deletes the Keyfactor component installation whose ID is provided.
ComponentInstallationApi GetComponentInstallation Get /ComponentInstallation Returns all Keyfactor component installations.
CustomJobTypeApi CreateJobTypesCustom Post /JobTypes/Custom Creates a custom job type with the provided properties
CustomJobTypeApi DeleteJobTypesCustomById Delete /JobTypes/Custom/{id} Deletes the custom job type associated with the provided id
CustomJobTypeApi GetJobTypesCustom Get /JobTypes/Custom Returns all custom job types according to the provided filter and output parameters
CustomJobTypeApi GetJobTypesCustomById Get /JobTypes/Custom/{id} Returns a single custom job type associated with the provided id
CustomJobTypeApi UpdateJobTypesCustom Put /JobTypes/Custom Updates an existing custom job type with the provided properties
DeniedAlertApi CreateAlertsDenied Post /Alerts/Denied Add a denied alert
DeniedAlertApi DeleteAlertsDeniedById Delete /Alerts/Denied/{id} Delete a denied alert
DeniedAlertApi GetAlertsDenied Get /Alerts/Denied Gets all denied alerts according to the provided filter and output parameters
DeniedAlertApi GetAlertsDeniedById Get /Alerts/Denied/{id} Get a denied alert
DeniedAlertApi UpdateAlertsDenied Put /Alerts/Denied Edit a denied alert
EnrollmentApi CreateEnrollmentCSR Post /Enrollment/CSR Performs a CSR Enrollment based upon the provided request
EnrollmentApi CreateEnrollmentCSRParse Post /Enrollment/CSR/Parse Parses the provided CSR and returns the properties
EnrollmentApi CreateEnrollmentPFX Post /Enrollment/PFX Performs a PFX Enrollment based upon the provided request
EnrollmentApi CreateEnrollmentPFXDeploy Post /Enrollment/PFX/Deploy Creates management jobs to install a newly enrolled pfx in to one or more certificate stores
EnrollmentApi CreateEnrollmentPFXReplace Post /Enrollment/PFX/Replace Creates management jobs to install a newly enrolled pfx into the same certificate stores as the previous certificate
EnrollmentApi CreateEnrollmentRenew Post /Enrollment/Renew Performs a renewal based upon the passed in request
EnrollmentApi GetEnrollmentAvailableRenewalIdById Get /Enrollment/AvailableRenewal/Id/{id} Returns the type of renewal available for a given certificate.
EnrollmentApi GetEnrollmentAvailableRenewalThumbprintThumbprint Get /Enrollment/AvailableRenewal/Thumbprint/{thumbprint} Returns the type of renewal available for a given certificate.
EnrollmentApi GetEnrollmentCSRContextMy Get /Enrollment/CSR/Context/My Returns the list of available CSR enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApi GetEnrollmentPFXContextMy Get /Enrollment/PFX/Context/My Returns the list of available PFX enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApi GetEnrollmentSettingsById Get /Enrollment/Settings/{id} Gets the template settings to use during enrollment. The response will be the resolved values for the settings. If there is a template specific setting, the template specific setting will be used in the response. If there is not a template specific setting, the global setting will be used in the response.
EventHandlerRegistrationApi CreateEventHandlerRegistration Post /EventHandlerRegistration Registers an event handler
EventHandlerRegistrationApi DeleteEventHandlerRegistrationById Delete /EventHandlerRegistration/{id} Deletes an event handler
EventHandlerRegistrationApi GetEventHandlerRegistration Get /EventHandlerRegistration Returns all registered event handlers according to the provided filter and output parameters
EventHandlerRegistrationApi GetEventHandlerRegistrationById Get /EventHandlerRegistration/{id} Returns a registered event handler that matches the provided ID
EventHandlerRegistrationApi UpdateEventHandlerRegistrationById Put /EventHandlerRegistration/{id} Updates a registered event handler's information
ExpirationAlertApi CreateAlertsExpiration Post /Alerts/Expiration Add an expiration alert
ExpirationAlertApi CreateAlertsExpirationTest Post /Alerts/Expiration/Test Test an Expiration Alert
ExpirationAlertApi CreateAlertsExpirationTestAll Post /Alerts/Expiration/TestAll Test All Expiration Alerts
ExpirationAlertApi DeleteAlertsExpirationById Delete /Alerts/Expiration/{id} Delete an expiration alert
ExpirationAlertApi GetAlertsExpiration Get /Alerts/Expiration Gets all expiration alerts according to the provided filter and output parameters
ExpirationAlertApi GetAlertsExpirationById Get /Alerts/Expiration/{id} Get an expiration alert
ExpirationAlertApi GetAlertsExpirationSchedule Get /Alerts/Expiration/Schedule Get the schedule for expiration alerts
ExpirationAlertApi UpdateAlertsExpiration Put /Alerts/Expiration Edit an expiration alert
ExpirationAlertApi UpdateAlertsExpirationSchedule Put /Alerts/Expiration/Schedule Edit schedule
ExtensionsApi CreateExtensionsScripts Post /Extensions/Scripts Adds a new script
ExtensionsApi DeleteExtensionsScriptsById Delete /Extensions/Scripts/{id} Deletes a script. Script cannot be configured to an alert or workflow.
ExtensionsApi GetExtensionsScripts Get /Extensions/Scripts Returns all scripts according to the provided filter and output parameters
ExtensionsApi GetExtensionsScriptsById Get /Extensions/Scripts/{id} Returns a single script that matches the provided Id
ExtensionsApi UpdateExtensionsScripts Put /Extensions/Scripts Updates a script
IdentityProviderApi CreateIdentityProviders Post /IdentityProviders Creates an OAuth identity provider and any provided parameters. The identity provider will be assigned to the Global Permission Set if no PermissionSet is specified in the request and the user is in a security role that belongs to the Global Permission Set.
IdentityProviderApi GetIdentityProviders Get /IdentityProviders Returns all OAuth identity providers according to the provided filter and output parameters and user's security role assigned permission sets.
IdentityProviderApi GetIdentityProvidersById Get /IdentityProviders/{id} Gets an OAuth identity provider and its parameters.
IdentityProviderApi GetIdentityProvidersTypes Get /IdentityProviders/Types Returns a list of all available identity provider types and corresponding type parameters.
IdentityProviderApi UpdateIdentityProvidersById Put /IdentityProviders/{id} Updates an OAuth identity provider and any provided parameters. The identity provider will be assigned to the Global Permission Set if no PermissionSet is specified in the request and the user is in a security role that belongs to the Global Permission Set.
IssuedAlertApi CreateAlertsIssued Post /Alerts/Issued Add a issued alert
IssuedAlertApi DeleteAlertsIssuedById Delete /Alerts/Issued/{id} Delete a issued alert
IssuedAlertApi GetAlertsIssued Get /Alerts/Issued Gets all issued alerts according to the provided filter and output parameters
IssuedAlertApi GetAlertsIssuedById Get /Alerts/Issued/{id} Get a issued alert
IssuedAlertApi GetAlertsIssuedSchedule Get /Alerts/Issued/Schedule Get the schedule for issued alerts
IssuedAlertApi UpdateAlertsIssued Put /Alerts/Issued Edit a issued alert
IssuedAlertApi UpdateAlertsIssuedSchedule Put /Alerts/Issued/Schedule Edit schedule
KeyApi CreateSSHKeysMyKey Post /SSH/Keys/MyKey Generates an SSH Key Pair for the requesting user.
KeyApi DeleteSSHKeysUnmanaged Delete /SSH/Keys/Unmanaged Deletes Unmanaged Keys associated with the provided identifiers
KeyApi DeleteSSHKeysUnmanagedById Delete /SSH/Keys/Unmanaged/{id} Deletes Unmanaged Key associated with the provided identifier
KeyApi GetSSHKeysMyKey Get /SSH/Keys/MyKey Returns the current key of the requesting user
KeyApi GetSSHKeysUnmanaged Get /SSH/Keys/Unmanaged Returns Unmanaged SSH keys
KeyApi GetSSHKeysUnmanagedById Get /SSH/Keys/Unmanaged/{id} Returns an unmanaged SSH key with provided id.
KeyApi UpdateSSHKeysMyKey Put /SSH/Keys/MyKey Updates the requesting user's SSH key
KeyRotationAlertApi CreateAlertsKeyRotation Post /Alerts/KeyRotation Add a key rotation alert
KeyRotationAlertApi CreateAlertsKeyRotationTest Post /Alerts/KeyRotation/Test Test An Alert
KeyRotationAlertApi CreateAlertsKeyRotationTestAll Post /Alerts/KeyRotation/TestAll Test All Alerts
KeyRotationAlertApi DeleteAlertsKeyRotationById Delete /Alerts/KeyRotation/{id} Delete a key rotation alert
KeyRotationAlertApi GetAlertsKeyRotation Get /Alerts/KeyRotation Gets all key rotation alerts according to the provided filter and output parameters
KeyRotationAlertApi GetAlertsKeyRotationById Get /Alerts/KeyRotation/{id} Get a key rotation alert
KeyRotationAlertApi GetAlertsKeyRotationSchedule Get /Alerts/KeyRotation/Schedule Get the schedule for key rotation alerts
KeyRotationAlertApi UpdateAlertsKeyRotation Put /Alerts/KeyRotation Edit a key rotation alert
KeyRotationAlertApi UpdateAlertsKeyRotationSchedule Put /Alerts/KeyRotation/Schedule Edit schedule
LicenseApi GetLicense Get /License Gets the current license
LogonApi CreateSSHLogons Post /SSH/Logons Creates a logon with the provided properties
LogonApi CreateSSHLogonsAccess Post /SSH/Logons/Access Updates the users with access to an existing logon
LogonApi DeleteSSHLogonsById Delete /SSH/Logons/{id} Deletes a Logon associated with the provided identifier
LogonApi GetSSHLogons Get /SSH/Logons Returns all Logons according to the provided filter parameters
LogonApi GetSSHLogonsById Get /SSH/Logons/{id} Fetches a Logon associated with the provided identifier
MacEnrollmentApi GetMacEnrollment Get /MacEnrollment Gets mac enrollment settings data
MacEnrollmentApi UpdateMacEnrollment Put /MacEnrollment Updates mac enrollment settings data
MetadataFieldApi CreateMetadataFields Post /MetadataFields Creates a new metadata field type with the given metadata field type properties
MetadataFieldApi DeleteMetadataFields Delete /MetadataFields Deletes multiple persisted metadata field types by their unique ids
MetadataFieldApi DeleteMetadataFieldsById Delete /MetadataFields/{id} Deletes a persisted metadata field type by its unique id
MetadataFieldApi GetMetadataFields Get /MetadataFields Returns all metadata field types according to the provided filter and output parameters
MetadataFieldApi GetMetadataFieldsById Get /MetadataFields/{id} Gets a persisted metadata field type by its unique id
MetadataFieldApi GetMetadataFieldsByIdInUse Get /MetadataFields/{id}/InUse Determines if a metadata field type associated with the provided identifier is currently in use
MetadataFieldApi GetMetadataFieldsName Get /MetadataFields/{name} Gets a persisted metadata field type by its unique name
MetadataFieldApi UpdateMetadataFields Put /MetadataFields Updates a persisted metadata field with the given metadata field type
MonitoringApi CreateMonitoringResolveOCSP Post /Monitoring/ResolveOCSP Resolve the Certificate authority given
MonitoringApi CreateMonitoringRevocation Post /Monitoring/Revocation Add a revocation monitoring endpoint
MonitoringApi CreateMonitoringRevocationCRLTest Post /Monitoring/Revocation/CRL/Test Validates the connection info for the CRL provided by the model.
MonitoringApi CreateMonitoringRevocationOCSPTest Post /Monitoring/Revocation/OCSP/Test Validates the connection info for the OCSP endpoint provided by the model.
MonitoringApi CreateMonitoringRevocationTest Post /Monitoring/Revocation/Test Test Alert
MonitoringApi CreateMonitoringRevocationTestAll Post /Monitoring/Revocation/TestAll Test All Alerts
MonitoringApi DeleteMonitoringRevocationById Delete /Monitoring/Revocation/{id} Delete a revocation monitoring endpoint
MonitoringApi GetMonitoringRevocation Get /Monitoring/Revocation Gets all revocation monitoring endpoints according to the provided filter and output parameters
MonitoringApi GetMonitoringRevocationById Get /Monitoring/Revocation/{id} Get a revocation monitoring endpoint
MonitoringApi UpdateMonitoringRevocation Put /Monitoring/Revocation Edit a revocation monitoring endpoint
MonitoringApi UpdateMonitoringRevocationSchedule Put /Monitoring/Revocation/Schedule Edit a revocation monitoring's schedule.
OrchestratorJobApi CreateOrchestratorJobsAcknowledge Post /OrchestratorJobs/Acknowledge Acknowledges orchestrator jobs based on the provided information
OrchestratorJobApi CreateOrchestratorJobsCustom Post /OrchestratorJobs/Custom Schedules a job for a custom JobType on the agent using the provided information
OrchestratorJobApi CreateOrchestratorJobsCustomBulk Post /OrchestratorJobs/Custom/Bulk Schedules the same job for a custom JobType on the specified agents using the provided information
OrchestratorJobApi CreateOrchestratorJobsReschedule Post /OrchestratorJobs/Reschedule Reschedules orchestrator jobs based on the provided information
OrchestratorJobApi CreateOrchestratorJobsUnschedule Post /OrchestratorJobs/Unschedule Unschedules orchestrator jobs based on the provided information
OrchestratorJobApi GetOrchestratorJobsJobHistory Get /OrchestratorJobs/JobHistory Returns all histories of an orchestrator job according to the provided filter and output parameters
OrchestratorJobApi GetOrchestratorJobsJobStatusData Get /OrchestratorJobs/JobStatus/Data Retrieves the results of a custom job using the provided information
OrchestratorJobApi GetOrchestratorJobsScheduledJobs Get /OrchestratorJobs/ScheduledJobs Returns all scheduled orchestrator jobs according to the provided filter and output parameters
PAMLocalEntriesApi CreatePamProvidersLocalProviderIdEntries Post /PamProviders/Local/{providerId}/Entries Creates a new local PAM entry with the associated properties
PAMLocalEntriesApi DeletePamProvidersLocalProviderIdEntries Delete /PamProviders/Local/{providerId}/Entries Deletes a local PAM entry
PAMLocalEntriesApi GetPamProvidersLocalProviderIdEntries Get /PamProviders/Local/{providerId}/Entries Returns local PAM entries for the given PAM provider according to the provided filter and output parameters
PAMLocalEntriesApi UpdatePamProvidersLocalProviderIdEntries Put /PamProviders/Local/{providerId}/Entries Updates local PAM entry with the associated properties
PAMProviderApi CreatePamProviders Post /PamProviders Creates a new PAM provider with the associated properties
PAMProviderApi CreatePamProvidersTypes Post /PamProviders/Types Creates a new PAM provider type with the associated properties
PAMProviderApi DeletePamProvidersById Delete /PamProviders/{id} Deletes a PAM Provider
PAMProviderApi DeletePamProvidersTypesById Delete /PamProviders/Types/{id} Deletes a PAM provider Type, as long as the PAM type is not currently in use.
PAMProviderApi GetPamProviders Get /PamProviders Returns all PAM providers according to the provided filter and output parameters
PAMProviderApi GetPamProvidersById Get /PamProviders/{id} Returns a single PAM Provider that matches the associated id
PAMProviderApi GetPamProvidersTypes Get /PamProviders/Types Returns all PAM provider types in the Keyfactor instance
PAMProviderApi UpdatePamProviders Put /PamProviders Updates an existing PAM provider according to the provided properties
PendingAlertApi CreateAlertsPending Post /Alerts/Pending Add a pending alert
PendingAlertApi CreateAlertsPendingTest Post /Alerts/Pending/Test Test pending alert. Will send alert emails if SendAlerts is true
PendingAlertApi CreateAlertsPendingTestAll Post /Alerts/Pending/TestAll Test all pending alerts. Will send alert emails if SendAlerts is true
PendingAlertApi DeleteAlertsPendingById Delete /Alerts/Pending/{id} Delete a pending alert
PendingAlertApi GetAlertsPending Get /Alerts/Pending Gets all pending alerts according to the provided filter and output parameters
PendingAlertApi GetAlertsPendingById Get /Alerts/Pending/{id} Get a pending alert
PendingAlertApi GetAlertsPendingSchedule Get /Alerts/Pending/Schedule Get the schedule for pending alerts
PendingAlertApi UpdateAlertsPending Put /Alerts/Pending Edit a pending alert
PendingAlertApi UpdateAlertsPendingSchedule Put /Alerts/Pending/Schedule Edit schedule
PermissionSetApi CreatePermissionSets Post /PermissionSets Creates a new permission set.
PermissionSetApi DeletePermissionSetsById Delete /PermissionSets/{id} Deletes a permission set.
PermissionSetApi GetPermissionSets Get /PermissionSets Gets all Permission Set(s) in the system if the user has a security role that is assigned to the Global Permission Set and the security role has the Global Security Read permission. Otherwise, returns only the Permission Sets with the Security Modify permission that are assigned to the user's security role(s).
PermissionSetApi GetPermissionSetsById Get /PermissionSets/{id} Gets permission set data.
PermissionSetApi GetPermissionSetsMy Get /PermissionSets/My
PermissionSetApi UpdatePermissionSets Put /PermissionSets
PermissionsApi GetPermissions Get /Permissions Gets all permissions in the system.
ReportsApi CreateReportsByIdSchedules Post /Reports/{id}/Schedules Create a built-in report's schedule that matches the id of the report.
ReportsApi CreateReportsCustom Post /Reports/Custom Creates a custom report
ReportsApi DeleteReportsCustomById Delete /Reports/Custom/{id} Delete custom report that matches the id
ReportsApi DeleteReportsSchedulesById Delete /Reports/Schedules/{id} Delete a built-in report's schedule that matches the id of the schedule.
ReportsApi GetReports Get /Reports Returns all built-in reports according to the provided filter and output parameters
ReportsApi GetReportsById Get /Reports/{id} Returns a single built-in report that matches the id
ReportsApi GetReportsByIdParameters Get /Reports/{id}/Parameters Get a built-in report's parameters that matches the id of the report.
ReportsApi GetReportsByIdSchedules Get /Reports/{id}/Schedules Get a built-in report's schedules that matches the id of the report.
ReportsApi GetReportsCustom Get /Reports/Custom Returns all custom reports according to the provided filter and output parameters
ReportsApi GetReportsCustomById Get /Reports/Custom/{id} Returns a single custom report that matches the id
ReportsApi GetReportsSchedulesById Get /Reports/Schedules/{id} Get a built-in report's schedule that matches the id of the schedule.
ReportsApi UpdateReports Put /Reports Updates a single built-in report that matches the id. Only some fields can be updated.
ReportsApi UpdateReportsByIdParameters Put /Reports/{id}/Parameters Update a built-in report's parameters that matches the id of the report.
ReportsApi UpdateReportsByIdSchedules Put /Reports/{id}/Schedules Update a built-in report's schedule that matches the id of the report.
ReportsApi UpdateReportsCustom Put /Reports/Custom Updates a custom report that matches the id
SMTPApi CreateSMTPTest Post /SMTP/Test Tests SMTP profile data
SMTPApi GetSMTP Get /SMTP Gets SMTP profile data
SMTPApi UpdateSMTP Put /SMTP Updates SMTP profile data
SchedulingApi CreateScheduling Post /Scheduling
SecurityApi CreateSecurityContainersByIdRoles Post /Security/Containers/{id}/Roles Edit a certificate store container's permissions. Reminder: Name field should be left blank.
SecurityApi CreateSecurityIdentities Post /Security/Identities Adds a new security identity to the system.
SecurityApi DeleteSecurityIdentitiesById Delete /Security/Identities/{id} Deletes the security identity whose ID is provided.
SecurityApi GetSecurityAuditCollectionsById Get /Security/Audit/Collections/{id} Gets a list of applicable security permissions for certificate collection
SecurityApi GetSecurityContainersByIdRoles Get /Security/Containers/{id}/Roles Returns all the permissions of a certificate store container through the id
SecurityApi GetSecurityIdentities Get /Security/Identities Returns all security identities according to the provided filter and output parameters.
SecurityApi GetSecurityIdentitiesById Get /Security/Identities/{id} Gets an object representing the permissions of the identity associated with the provided identifier.
SecurityApi GetSecurityIdentitiesLookup Get /Security/Identities/Lookup Validates that the identity with the name given exists.
SecurityApi GetSecurityMy Get /Security/My Looks at all the roles and global permissions for the user and returns them.
SecurityClaimsApi CreateSecurityClaims Post /Security/Claims Adds a new claim definition to the system.
SecurityClaimsApi DeleteSecurityClaimsById Delete /Security/Claims/{id} Removes a claim definition from the system.
SecurityClaimsApi GetSecurityClaims Get /Security/Claims Returns all claim definitions according to the provided filter and output parameters.
SecurityClaimsApi GetSecurityClaimsById Get /Security/Claims/{id} Returns a single claim definition that matches the id.
SecurityClaimsApi GetSecurityClaimsRoles Get /Security/Claims/Roles Returns a list of roles granted by the claim with the provided id.
SecurityClaimsApi UpdateSecurityClaims Put /Security/Claims Updates an existing claim definition.
SecurityRolePermissionsApi CreateSecurityRolesByIdPermissionsCollections Post /Security/Roles/{id}/Permissions/Collections Adds collection permissions to the security role that matches the id.
SecurityRolePermissionsApi CreateSecurityRolesByIdPermissionsContainers Post /Security/Roles/{id}/Permissions/Containers Adds container permissions to the security role that matches the id.
SecurityRolePermissionsApi CreateSecurityRolesByIdPermissionsGlobal Post /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolePermissionsApi GetSecurityRolesByIdPermissions Get /Security/Roles/{id}/Permissions Returns all permissions associated with the security role that matches the id.
SecurityRolePermissionsApi GetSecurityRolesByIdPermissionsCollections Get /Security/Roles/{id}/Permissions/Collections Returns all collection permissions associated with the security role that matches the id.
SecurityRolePermissionsApi GetSecurityRolesByIdPermissionsContainers Get /Security/Roles/{id}/Permissions/Containers Returns all container permissions associated with the security role that matches the id.
SecurityRolePermissionsApi GetSecurityRolesByIdPermissionsGlobal Get /Security/Roles/{id}/Permissions/Global Returns all global permissions associated with the security role that matches the id.
SecurityRolePermissionsApi GetSecurityRolesByIdPermissionsPamProviders Get /Security/Roles/{id}/Permissions/PamProviders Returns all PAM provider permissions associated with the security role that matches the id.
SecurityRolePermissionsApi UpdateSecurityRolesByIdPermissionsCollections Put /Security/Roles/{id}/Permissions/Collections Sets collection permissions to the security role that matches the id.
SecurityRolePermissionsApi UpdateSecurityRolesByIdPermissionsContainers Put /Security/Roles/{id}/Permissions/Containers Sets container permissions to the security role that matches the id.
SecurityRolePermissionsApi UpdateSecurityRolesByIdPermissionsGlobal Put /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolePermissionsApi UpdateSecurityRolesByIdPermissionsPamProviders Put /Security/Roles/{id}/Permissions/PamProviders Sets PAM provider permissions to the security role that matches the id.
SecurityRolesApi CreateSecurityRoles Post /Security/Roles Adds a new security role to the system. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi CreateSecurityRolesByIdCopy Post /Security/Roles/{id}/Copy Makes a copy of an existing security role. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi DeleteSecurityRolesById Delete /Security/Roles/{id} Deletes the security role whose ID is provided.
SecurityRolesApi GetSecurityRoles Get /Security/Roles Returns all security roles according to the provided filter and output parameters. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi GetSecurityRolesById Get /Security/Roles/{id} Returns a single security role that matches the id. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi GetSecurityRolesByIdIdentities Get /Security/Roles/{id}/Identities Returns all identities which have the security role that matches the id. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi UpdateSecurityRoles Put /Security/Roles Updates a security role that matches the id. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
SecurityRolesApi UpdateSecurityRolesByIdIdentities Put /Security/Roles/{id}/Identities Updates the identities which have the security role that matches the id. The v1 endpoints for Security Roles will only work against AD Identities. Please use the v2 endpoints instead.
ServerApi CreateSSHServers Post /SSH/Servers Creates a server with the provided properties
ServerApi CreateSSHServersAccess Post /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi DeleteSSHServersAccess Delete /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi DeleteSSHServersById Delete /SSH/Servers/{id} Deletes a Server associated with the provided identifier
ServerApi GetSSHServers Get /SSH/Servers Returns all servers according to the provided filter parameters
ServerApi GetSSHServersAccessById Get /SSH/Servers/Access/{id} Retrieves logons and users with access to those logons for an existing server
ServerApi GetSSHServersById Get /SSH/Servers/{id} Returns a Server associated with the provided identifier
ServerApi UpdateSSHServers Put /SSH/Servers Updates an existing server with the provided properties
ServerGroupApi CreateSSHServerGroups Post /SSH/ServerGroups Creates a server group with the provided properties
ServerGroupApi CreateSSHServerGroupsAccess Post /SSH/ServerGroups/Access Add access rules to the server group
ServerGroupApi DeleteSSHServerGroupsAccess Delete /SSH/ServerGroups/Access Removes access mappings for the specified server group
ServerGroupApi DeleteSSHServerGroupsById Delete /SSH/ServerGroups/{id} Deletes a ServerGroup associated with the provided identifier
ServerGroupApi GetSSHServerGroups Get /SSH/ServerGroups Returns all server groups according to the provided filter parameters
ServerGroupApi GetSSHServerGroupsAccessById Get /SSH/ServerGroups/Access/{id} Retrieves logons and users with access to those logons for an existing server group
ServerGroupApi GetSSHServerGroupsById Get /SSH/ServerGroups/{id} Returns a ServerGroup associated with the provided identifier
ServerGroupApi GetSSHServerGroupsName Get /SSH/ServerGroups/{name} Returns a ServerGroup associated with the provided identifier
ServerGroupApi UpdateSSHServerGroups Put /SSH/ServerGroups Updates an existing server group with the provided properties
ServiceAccountApi CreateSSHServiceAccounts Post /SSH/ServiceAccounts Creates a ServiceAccount with the provided properties
ServiceAccountApi CreateSSHServiceAccountsRotateById Post /SSH/ServiceAccounts/Rotate/{id} Rotate an SSH key for a specified service account.
ServiceAccountApi DeleteSSHServiceAccounts Delete /SSH/ServiceAccounts Deletes Service Accounts associated with the provided identifiers
ServiceAccountApi DeleteSSHServiceAccountsById Delete /SSH/ServiceAccounts/{id} Deletes a ServiceAccount associated with the provided identifier
ServiceAccountApi GetSSHServiceAccounts Get /SSH/ServiceAccounts Returns all ServiceAccounts according to the provided filter parameters
ServiceAccountApi GetSSHServiceAccountsById Get /SSH/ServiceAccounts/{id} Returns a ServiceAccount associated with the provided identifier
ServiceAccountApi GetSSHServiceAccountsKeyById Get /SSH/ServiceAccounts/Key/{id} Returns an SSH key with or without private key based on the provided parameters.
ServiceAccountApi UpdateSSHServiceAccounts Put /SSH/ServiceAccounts Updates an SSH key for a specified service account.
SslApi CreateSSLNetworkRanges Post /SSL/NetworkRanges Adds the provided network range definitions to the associated network definition
SslApi CreateSSLNetworkRangesValidate Post /SSL/NetworkRanges/Validate Validates the format (using regular expressions) of the provided network range definitions
SslApi CreateSSLNetworks Post /SSL/Networks Creates a network definition according to the provided properties
SslApi CreateSSLNetworksByIdReset Post /SSL/Networks/{id}/Reset Resets all SSL scans associated with a network
SslApi CreateSSLNetworksByIdScan Post /SSL/Networks/{id}/Scan Starts an SSL Scan for the network according to the associated network definition
SslApi DeleteSSLNetworkRangesById Delete /SSL/NetworkRanges/{id} Removes all network range definitions from the associated network definition
SslApi DeleteSSLNetworksById Delete /SSL/Networks/{id} Removes a network definition according to the provided identifier
SslApi GetSSL Get /SSL Returns a list of the endpoint scan results according to the provided filter and output parameters
SslApi GetSSLEndpointsById Get /SSL/Endpoints/{id} Returns the details of the associated scanning endpoint
SslApi GetSSLEndpointsByIdHistory Get /SSL/Endpoints/{id}/History Returns a list of the scan results for the provided endpoint according to the provided filter and output parameters
SslApi GetSSLNetworkRangesById Get /SSL/NetworkRanges/{id} Returns the network range definitions for the provided network definition
SslApi GetSSLNetworks Get /SSL/Networks Returns all defined SSL networks according to the provided filter and output parameters
SslApi GetSSLNetworksByIdParts Get /SSL/Networks/{id}/Parts Returns the scan job components comprising the entire scan job to be executed
SslApi GetSSLNetworksIdentifier Get /SSL/Networks/{identifier} Returns a defined SSL network according to the provided name
SslApi GetSSLPartsById Get /SSL/Parts/{id} Returns the execution details of the associated network scan job part
SslApi UpdateSSLEndpointsMonitorAll Put /SSL/Endpoints/MonitorAll Sets all endpoints matching the provided query as 'monitored'
SslApi UpdateSSLEndpointsMonitorStatus Put /SSL/Endpoints/MonitorStatus Sets the monitored status according to the provided endpoint and boolean status
SslApi UpdateSSLEndpointsReviewAll Put /SSL/Endpoints/ReviewAll Sets all endpoints matching the provided query as 'reviewed'
SslApi UpdateSSLEndpointsReviewStatus Put /SSL/Endpoints/ReviewStatus Sets the reviewed status according to the provided endpoint and boolean status
SslApi UpdateSSLNetworkRanges Put /SSL/NetworkRanges Configures network range definitions for the provided network
SslApi UpdateSSLNetworks Put /SSL/Networks Updates an existing network definition according to the provided properties
StatusApi GetStatusEndpoints Get /Status/Endpoints Returns all endpoints to which the requesting identity has access
StatusApi GetStatusHealthCheck Get /Status/HealthCheck Returns the current status of the API's ability to connect to the database.
TemplateApi CreateTemplatesImport Post /Templates/Import Imports templates from the provided configuration tenant
TemplateApi GetTemplates Get /Templates Returns all certificate templates according to the provided filter and output parameters
TemplateApi GetTemplatesById Get /Templates/{id} Returns the certificate template associated with the provided id
TemplateApi GetTemplatesSettings Get /Templates/Settings Gets the global template settings.
TemplateApi GetTemplatesSubjectParts Get /Templates/SubjectParts Returns the valid subject parts possible for regular expressions.
TemplateApi UpdateTemplates Put /Templates Updates a certificate template according to the provided properties
TemplateApi UpdateTemplatesSettings Put /Templates/Settings Replaces the existing global template settings.
UserApi CreateSSHUsers Post /SSH/Users Creates a new SSH User.
UserApi CreateSSHUsersAccess Post /SSH/Users/Access Updates logon access for a user
UserApi DeleteSSHUsersById Delete /SSH/Users/{id} Deletes an SSH user.
UserApi GetSSHUsers Get /SSH/Users Returns users matching the criteria from the provided query parameters
UserApi GetSSHUsersById Get /SSH/Users/{id} Looks up information about an existing SSH user.
UserApi UpdateSSHUsers Put /SSH/Users Updates information about a given user.
WorkflowApi CreateWorkflowCertificatesApprove Post /Workflow/Certificates/Approve Approves pending certificate requests associated with the provided ids
WorkflowApi CreateWorkflowCertificatesDeny Post /Workflow/Certificates/Deny Denies pending certificate requests associated with the provided ids
WorkflowApi GetWorkflowCertificatesById Get /Workflow/Certificates/{id} Returns certificate request details based on the provided ID.
WorkflowApi GetWorkflowCertificatesDenied Get /Workflow/Certificates/Denied Gets a collection of denied certificate requests based on the provided query.
WorkflowApi GetWorkflowCertificatesExternalValidation Get /Workflow/Certificates/ExternalValidation Gets a collection of external validation certificate requests based on the provided query.
WorkflowApi GetWorkflowCertificatesPending Get /Workflow/Certificates/Pending Gets a collection of pending certificate requests based on the provided query.
WorkflowDefinitionApi CreateWorkflowDefinitions Post /Workflow/Definitions Creates a new base definition without any steps.
WorkflowDefinitionApi CreateWorkflowDefinitionsDefinitionIdPublish Post /Workflow/Definitions/{definitionId}/Publish Makes the most recent version of a Workflow Definition the published version.
WorkflowDefinitionApi CreateWorkflowDefinitionsDefinitionIdPublishVersion Post /Workflow/Definitions/{definitionId}/Publish/{version} Makes the specified version of a Workflow Definition the published version.
WorkflowDefinitionApi DeleteWorkflowDefinitionsDefinitionId Delete /Workflow/Definitions/{definitionId} Deletes the definition matching the given Id.
WorkflowDefinitionApi GetWorkflowDefinitions Get /Workflow/Definitions Gets the Definitions matching the query specifications.
WorkflowDefinitionApi GetWorkflowDefinitionsDefinitionId Get /Workflow/Definitions/{definitionId} Gets a workflow definition.
WorkflowDefinitionApi GetWorkflowDefinitionsSteps Get /Workflow/Definitions/Steps Gets the result set of available steps for a given query.
WorkflowDefinitionApi GetWorkflowDefinitionsStepsExtensionName Get /Workflow/Definitions/Steps/{extensionName} Gets the schema of a given step with the specified extension name.
WorkflowDefinitionApi GetWorkflowDefinitionsTypes Get /Workflow/Definitions/Types Performs a query against the workflow types in the system.
WorkflowDefinitionApi UpdateWorkflowDefinitionsDefinitionId Put /Workflow/Definitions/{definitionId} Updates the existing definition's DisplayName and Description.
WorkflowDefinitionApi UpdateWorkflowDefinitionsDefinitionIdStatus Put /Workflow/Definitions/{definitionId}/Status Updates the definition status matching the given Id.
WorkflowDefinitionApi UpdateWorkflowDefinitionsDefinitionIdSteps Put /Workflow/Definitions/{definitionId}/Steps Sets the provided steps on the latest version of the definition.
WorkflowInstanceApi CreateWorkflowInstancesInstanceIdRestart Post /Workflow/Instances/{instanceId}/Restart Restarts a failed instance against the specified definition version or the published version if no version is specified.
WorkflowInstanceApi CreateWorkflowInstancesInstanceIdSignals Post /Workflow/Instances/{instanceId}/Signals Receives the given signal for the given instance.
WorkflowInstanceApi CreateWorkflowInstancesInstanceIdStop Post /Workflow/Instances/{instanceId}/Stop Rejects an instance, preventing it from continuing.
WorkflowInstanceApi DeleteWorkflowInstancesInstanceId Delete /Workflow/Instances/{instanceId} Deletes the specified instance.
WorkflowInstanceApi GetWorkflowInstances Get /Workflow/Instances Gets the workflow instances matching the query specifications.
WorkflowInstanceApi GetWorkflowInstancesAssignedToMe Get /Workflow/Instances/AssignedToMe Gets the workflow instances waiting on the user.
WorkflowInstanceApi GetWorkflowInstancesInstanceId Get /Workflow/Instances/{instanceId} Get information relevant for knowing where an instance is in its workflow.
WorkflowInstanceApi GetWorkflowInstancesMy Get /Workflow/Instances/My Gets the workflow instances started by the user.

Documentation For Models

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author