keyfactor-go-client-sdk

module
v11.0.0-rc5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2024 License: Apache-2.0

README

Go API client for command

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.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

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

Configuration

The command.NewConfiguration() method is used to configure the Keyfactor Go Client SDK. The client can be configured by passing a map of configuration options to the NewConfiguration() method, or by passing a blank map and setting the configuration options individually on the returned Configuration object.

The following configuration options are available:

// Create a configuration map
config := make(map[string]string)
config["host"] = "keyfactor.example.com"
config["username"] = "admin"
config["password"] = "password"
config["domain"] = "example.com" // optional
config["caCertificatePath"] = "/path/to/local/certificate" // optional

// Create a configuration object
kfcmdConfiguration := command.NewConfiguration(config)
if kfcmdConfiguration == nil {
    // handle error
}

// Create a client
client := keyfactor.NewAPIClient(config)
if client == nil {
    // handle error
}

or

// Create a configuration object
kfcmdConfiguration := command.NewConfiguration(make(map[string]string))

// Set configuration options individually
kfcmdConfiguration.Host = "keyfactor.example.com"
kfcmdConfiguration.BasicAuth.Username = "admin"
kfcmdConfiguration.BasicAuth.Password = "password"
kfcmdConfiguration.CaCertificatePath = "/path/to/local/certificate" // optional

// Create a client
client := keyfactor.NewAPIClient(kfcmdConfiguration)
if client == nil {
    // handle error
}

The root CA certificate can also be configured by passing a slice of *x509.Certificate objects to the kfcmd.Configuration.SetCaCertificates() method.

// Create a configuration object
kfcmdConfiguration := command.NewConfiguration(make(map[string]string))

// Set the root CA certificate
kfcmdConfiguration.SetCaCertificates([]*x509.Certificate{caCertificate})

// Create a client
client := keyfactor.NewAPIClient(kfcmdConfiguration)

Documentation for API Endpoints

All URIs are relative to /Keyfactor/API

Class Method HTTP request Description
AgentApi AgentsApprovePost Post /Agents/Approve Approve a list of agents
AgentApi AgentsDisapprovePost Post /Agents/Disapprove Disapprove a list of agents
AgentApi AgentsGet Get /Agents Returns all agents according to the provided filter and output parameters
AgentApi AgentsIdFetchLogsPost Post /Agents/{id}/FetchLogs Schedules a job on the agent to retrieve log files
AgentApi AgentsIdGet Get /Agents/{id} Returns details for a single agent, specified by ID
AgentApi AgentsIdResetPost Post /Agents/{id}/Reset Reset an agent to a new state
AgentApi AgentsResetPost Post /Agents/Reset Reset a list of agents
AgentApi AgentsSetAuthCertificateReenrollmentPost 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.
AgentBlueprintApi AgentBluePrintApplyBlueprintPost Post /AgentBluePrint/ApplyBlueprint Applies the selected agent blueprint to the provided agents
AgentBlueprintApi AgentBluePrintGenerateBluePrintPost Post /AgentBluePrint/GenerateBluePrint Generates an agent blueprint from the provided agents
AgentBlueprintApi AgentBluePrintGet Get /AgentBluePrint Returns all agent blueprints according to the provided filter and output parameters
AgentBlueprintApi AgentBluePrintIdDelete Delete /AgentBluePrint/{id} Deletes an agent blueprint by its Keyfactor identifier
AgentBlueprintApi AgentBluePrintIdGet Get /AgentBluePrint/{id} Returns an agent blueprint according to the provided filter and output parameters
AgentBlueprintApi AgentBluePrintIdJobsGet Get /AgentBluePrint/{id}/Jobs Gets the agent blueprint scheduled jobs
AgentBlueprintApi AgentBluePrintIdStoresGet Get /AgentBluePrint/{id}/Stores Gets the agent blueprint certificate stores
AgentPoolApi AgentPoolsAgentsGet Get /AgentPools/Agents Returns all agents for the default agent pool
AgentPoolApi AgentPoolsGet Get /AgentPools Returns all agent pools according to the provided filter and output parameters
AgentPoolApi AgentPoolsIdDelete Delete /AgentPools/{id} Deletes the agent pool associated with the provided id
AgentPoolApi AgentPoolsIdGet Get /AgentPools/{id} Returns a single agent pool associated with the provided id
AgentPoolApi AgentPoolsPost Post /AgentPools Creates an agent pool with the provided properties
AgentPoolApi AgentPoolsPut Put /AgentPools Updates an existing agent pool with the provided properties
AppSettingApi AppSettingGet Get /AppSetting Get available application settings
AppSettingApi AppSettingIdGet Get /AppSetting/{id} Get application setting by id
AppSettingApi AppSettingIdSetPut Put /AppSetting/{id}/Set Update one application setting by id
AppSettingApi AppSettingNameSetPut Put /AppSetting/{name}/Set Update one application setting by short name
AppSettingApi AppSettingPut Put /AppSetting Bulk update available application settings
AuditLogApi AuditDownloadGet Get /Audit/Download Returns a Comma Separated file containing the audit log entries according to the provided filter
AuditLogApi AuditGet Get /Audit Returns all audit log entries according to the provided filter and output parameters
AuditLogApi AuditIdGet Get /Audit/{id} Returns the audit log entry associated with the provided identifier
AuditLogApi AuditIdValidateGet Get /Audit/{id}/Validate Validates the audit log entry associated with the provided keyfactor id
AuditLogApi AuditRelatedEntitiesGet Get /Audit/RelatedEntities Returns the audit log entry associated with the provided keyfactor id
CSRGenerationApi CSRGenerationGeneratePost Post /CSRGeneration/Generate Generates a CSR according the properties provided
CSRGenerationApi CSRGenerationPendingDelete Delete /CSRGeneration/Pending Deletes the CSRs associated with the provided identifiers
CSRGenerationApi CSRGenerationPendingGet Get /CSRGeneration/Pending Returns a list of the currently pending CSRs according to the provided query
CSRGenerationApi CSRGenerationPendingIdDelete Delete /CSRGeneration/Pending/{id} Deletes a CSR associated with the provided identifier
CSRGenerationApi CSRGenerationPendingIdGet Get /CSRGeneration/Pending/{id} Returns a previously generated CSR associated with the provided identifier
CertificateApi CertificatesAnalyzePost Post /Certificates/Analyze Returns the public information of the certificate
CertificateApi CertificatesCSVGet Get /Certificates/CSV Returns a comma-delimited CSV file containing all certificates in the database
CertificateApi CertificatesDelete Delete /Certificates Deletes multiple persisted certificates by their unique ids
CertificateApi CertificatesDownloadPost Post /Certificates/Download Downloads the persisted certificate associated with the provided query
CertificateApi CertificatesGet Get /Certificates Returns all certificates according to the provided filter and output parameters
CertificateApi CertificatesIdDelete Delete /Certificates/{id} Deletes a persisted certificate by its unique id as well as the stored private key (if present) associated with it
CertificateApi CertificatesIdGet Get /Certificates/{id} Returns a single certificate that matches the id
CertificateApi CertificatesIdHistoryGet Get /Certificates/{id}/History Gets the history of operations on a certificate
CertificateApi CertificatesIdSecurityGet Get /Certificates/{id}/Security Gets the list of Security Identities and which permissions they have on the given certificate.
CertificateApi CertificatesIdValidateGet Get /Certificates/{id}/Validate Validates the certificate chain can be built.
CertificateApi CertificatesIdentityAuditIdGet Get /Certificates/IdentityAudit/{id} Audit identity permissions for certificate
CertificateApi CertificatesImportPost Post /Certificates/Import Imports the provided certificate into the Keyfactor instance, including any provided associated data
CertificateApi CertificatesLocationsIdGet Get /Certificates/Locations/{id} Returns a list of locations the certificate is in
CertificateApi CertificatesMetadataAllPut Put /Certificates/Metadata/All Updates the metadata for certificates associated with the certificate identifiers or query provided
CertificateApi CertificatesMetadataCompareGet Get /Certificates/Metadata/Compare Compares the metadata value provided with the metadata value associated with the specified certificate
CertificateApi CertificatesMetadataPut Put /Certificates/Metadata Updates the metadata for the certificate associated with the identifier provided
CertificateApi CertificatesPrivateKeyDelete Delete /Certificates/PrivateKey Deletes the persisted private keys of multiple certificates by the unique ids of the Certificates
CertificateApi CertificatesPrivateKeyIdDelete Delete /Certificates/PrivateKey/{id} Deletes the persisted private key of the certificate associated with the provided identifier
CertificateApi CertificatesQueryDelete Delete /Certificates/Query Deletes multiple persisted certificate entities selected by a given query
CertificateApi CertificatesRecoverPost Post /Certificates/Recover Recovers the persisted certificate associated with the provided query
CertificateApi CertificatesRevokePost Post /Certificates/Revoke Revokes the certificates associated with the provided identifiers and associates the provided data with the revocation
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAHealthRecipientsGet Get /CertificateAuthority/AlertRecipients/CAHealthRecipients Returns a list of all CA health recipients
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAHealthRecipientsIdDelete Delete /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Deletes a CA health recipient for the provided ID
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAHealthRecipientsIdGet Get /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Returns a CA health recipient for the specified health recipient ID
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAHealthRecipientsIdPut Put /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id} Updates a CA health alert recipient for the provided request object
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAHealthRecipientsPost Post /CertificateAuthority/AlertRecipients/CAHealthRecipients Creates CA health monitoring recipients for the provided list of email addresses"
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAThresholdRecipientsGet Get /CertificateAuthority/AlertRecipients/CAThresholdRecipients Returns a list of all CA threshold recipients
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAThresholdRecipientsIdDelete Delete /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Deletes a CA threshold recipient for the provided ID
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAThresholdRecipientsIdGet Get /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Returns a CA threshold recipient for the specified threshold alert recipient ID
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAThresholdRecipientsIdPut Put /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id} Updates a CA threshold alert recipient for the provided request object
CertificateAuthorityApi CertificateAuthorityAlertRecipientsCAThresholdRecipientsPost Post /CertificateAuthority/AlertRecipients/CAThresholdRecipients Creates CA threshold alert recipients for the provided list of emails
CertificateAuthorityApi CertificateAuthorityAvailableForestsGet Get /CertificateAuthority/AvailableForests Returns a list of available forests that are in active directory
CertificateAuthorityApi CertificateAuthorityGet Get /CertificateAuthority Returns all certificate authorities according to the provided filter
CertificateAuthorityApi CertificateAuthorityHealthMonitoringScheduleGet Get /CertificateAuthority/HealthMonitoring/Schedule Retrieves the execution schedule for the CA health monitoring job
CertificateAuthorityApi CertificateAuthorityIdDelete Delete /CertificateAuthority/{id} Deletes a CertificateAuthority from the system, specified by ID
CertificateAuthorityApi CertificateAuthorityIdGet Get /CertificateAuthority/{id} Returns details for a single CA, specified by ID
CertificateAuthorityApi CertificateAuthorityImportPost Post /CertificateAuthority/Import Imports any certificate authorities from the provided configuration tenant DNS
CertificateAuthorityApi CertificateAuthorityPost Post /CertificateAuthority Creates a new CertificateAuthority object
CertificateAuthorityApi CertificateAuthorityPublishCRLPost Post /CertificateAuthority/PublishCRL Publishes a CRL according to the provided request
CertificateAuthorityApi CertificateAuthorityPut Put /CertificateAuthority Updates a CertificateAuthority object
CertificateAuthorityApi CertificateAuthoritySourceCountGet Get /CertificateAuthority/SourceCount Returns a count of certificate authorities with sync enabled
CertificateAuthorityApi CertificateAuthorityTestPost Post /CertificateAuthority/Test Validates the connection info for the CA provided by the model.
CertificateCollectionApi CertificateCollectionsCollectionListGet Get /CertificateCollections/CollectionList Get certificate collection list with duplication field name
CertificateCollectionApi CertificateCollectionsCopyPost 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 CertificateCollectionsGet Get /CertificateCollections Returns all certificate collections
CertificateCollectionApi CertificateCollectionsIdDelete Delete /CertificateCollections/{id} Delete one certificate collection
CertificateCollectionApi CertificateCollectionsIdFavoritePut Put /CertificateCollections/{id}/Favorite Update favorite for one collection
CertificateCollectionApi CertificateCollectionsIdGet Get /CertificateCollections/{id} Returns the certificate collection definition associated with the provided Keyfactor identifier
CertificateCollectionApi CertificateCollectionsNameGet Get /CertificateCollections/{name} Returns the certificate collection associated with the provided collection name
CertificateCollectionApi CertificateCollectionsNavItemsGet Get /CertificateCollections/NavItems Get the list of navigation items for certificate collection
CertificateCollectionApi CertificateCollectionsPost Post /CertificateCollections Creates a new certificate collection with the provided properties
CertificateCollectionApi CertificateCollectionsPut Put /CertificateCollections Updates an existing certificate collection with the provided properties
CertificateStoreApi CertificateStoresApprovePost Post /CertificateStores/Approve Approves the provided certificate stores to make them available for management
CertificateStoreApi CertificateStoresAssignContainerPut Put /CertificateStores/AssignContainer Assigns the provided certificate stores to the provided container
CertificateStoreApi CertificateStoresCertificatesAddPost Post /CertificateStores/Certificates/Add Configures a management job to add a certificate to one or more stores with the provided schedule
CertificateStoreApi CertificateStoresCertificatesRemovePost Post /CertificateStores/Certificates/Remove Configures a management job to remove a certificate from one or more stores with the provided schedule
CertificateStoreApi CertificateStoresDelete Delete /CertificateStores Deletes multiple persisted certificate store entities by their identifiers
CertificateStoreApi CertificateStoresDiscoveryJobPut Put /CertificateStores/DiscoveryJob Configures a discovery job to locate currently unmanaged certificate stores
CertificateStoreApi CertificateStoresGet Get /CertificateStores Returns all certificate stores according to the provided filter and output parameters
CertificateStoreApi CertificateStoresIdDelete Delete /CertificateStores/{id} Deletes a persisted certificate store by its Keyfactor identifier
CertificateStoreApi CertificateStoresIdGet Get /CertificateStores/{id} Returns a single certificate store associated with the provided id
CertificateStoreApi CertificateStoresIdInventoryGet Get /CertificateStores/{id}/Inventory Returns a single certificate store's inventory associated with the provided id
CertificateStoreApi CertificateStoresPasswordPut Put /CertificateStores/Password Sets a password for the requested certificate store
CertificateStoreApi CertificateStoresPost Post /CertificateStores Creates a new certificate store with the provided properties
CertificateStoreApi CertificateStoresPut Put /CertificateStores Updates a given certificate store with the properties of the provided instance
CertificateStoreApi CertificateStoresReenrollmentPost Post /CertificateStores/Reenrollment Schedules a certificate store for reenrollment
CertificateStoreApi CertificateStoresSchedulePost Post /CertificateStores/Schedule Creates an inventory schedule for the provided certificate stores
CertificateStoreApi CertificateStoresServerGet Get /CertificateStores/Server Returns all certificate store servers according to the provided filter and output parameters
CertificateStoreApi CertificateStoresServerPost Post /CertificateStores/Server Creates a new certificate store server with the provided properties
CertificateStoreApi CertificateStoresServerPut Put /CertificateStores/Server Updates a given certificate store server with the properties of the provided instance
CertificateStoreContainerApi CertificateStoreContainersGet Get /CertificateStoreContainers Returns all certificate store container according to the provided filter and output parameters
CertificateStoreContainerApi CertificateStoreContainersIdDelete Delete /CertificateStoreContainers/{id} Delete a certificate store container
CertificateStoreContainerApi CertificateStoreContainersIdGet Get /CertificateStoreContainers/{id} Returns a single certificate store container that matches id
CertificateStoreContainerApi CertificateStoreContainersPost Post /CertificateStoreContainers Add a certificate store container
CertificateStoreContainerApi CertificateStoreContainersPut Put /CertificateStoreContainers Edit a certificate store container
CertificateStoreTypeApi CertificateStoreTypesDelete Delete /CertificateStoreTypes Deletes certificate store types according to the provided identifiers
CertificateStoreTypeApi CertificateStoreTypesGet Get /CertificateStoreTypes Returns all certificate store types according to the provided filter and output parameters
CertificateStoreTypeApi CertificateStoreTypesIdDelete Delete /CertificateStoreTypes/{id} Deletes a certificate store type according to the provided identifier
CertificateStoreTypeApi CertificateStoreTypesIdGet Get /CertificateStoreTypes/{id} Returns a single certificate store type that matches id
CertificateStoreTypeApi CertificateStoreTypesNameNameGet Get /CertificateStoreTypes/Name/{name} Returns a single certificate store type that matches the provided short name
CertificateStoreTypeApi CertificateStoreTypesPost Post /CertificateStoreTypes Creates a new certificate store type with the provided properties
CertificateStoreTypeApi CertificateStoreTypesPut Put /CertificateStoreTypes Updates an existing certificate store type with the provided properties
ComponentInstallationApi ComponentInstallationGet Get /ComponentInstallation Returns all Keyfactor component installations.
ComponentInstallationApi ComponentInstallationIdDelete Delete /ComponentInstallation/{id} Deletes the Keyfactor component installation whose ID is provided.
CustomJobTypeApi JobTypesCustomGet Get /JobTypes/Custom Returns all custom job types according to the provided filter and output parameters
CustomJobTypeApi JobTypesCustomIdDelete Delete /JobTypes/Custom/{id} Deletes the custom job type associated with the provided id
CustomJobTypeApi JobTypesCustomIdGet Get /JobTypes/Custom/{id} Returns a single custom job type associated with the provided id
CustomJobTypeApi JobTypesCustomPost Post /JobTypes/Custom Creates a custom job type with the provided properties
CustomJobTypeApi JobTypesCustomPut Put /JobTypes/Custom Updates an existing custom job type with the provided properties
DeniedAlertApi AlertsDeniedGet Get /Alerts/Denied Gets all denied alerts according to the provided filter and output parameters
DeniedAlertApi AlertsDeniedIdDelete Delete /Alerts/Denied/{id} Delete a denied alert
DeniedAlertApi AlertsDeniedIdGet Get /Alerts/Denied/{id} Get a denied alert
DeniedAlertApi AlertsDeniedPost Post /Alerts/Denied Add a denied alert
DeniedAlertApi AlertsDeniedPut Put /Alerts/Denied Edit a denied alert
EnrollmentApi EnrollmentAvailableRenewalIdIdGet Get /Enrollment/AvailableRenewal/Id/{id} Returns the type of renewal available for a given certificate.
EnrollmentApi EnrollmentAvailableRenewalThumbprintThumbprintGet Get /Enrollment/AvailableRenewal/Thumbprint/{thumbprint} Returns the type of renewal available for a given certificate.
EnrollmentApi EnrollmentCSRContextMyGet 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 EnrollmentCSRParsePost Post /Enrollment/CSR/Parse Parses the provided CSR and returns the properties
EnrollmentApi EnrollmentCSRPost Post /Enrollment/CSR Performs a CSR Enrollment based upon the provided request
EnrollmentApi EnrollmentPFXContextMyGet 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 EnrollmentPFXDeployPost Post /Enrollment/PFX/Deploy Creates management jobs to install a newly enrolled pfx in to one or more certificate stores
EnrollmentApi EnrollmentPFXPost Post /Enrollment/PFX Performs a PFX Enrollment based upon the provided request
EnrollmentApi EnrollmentPFXReplacePost Post /Enrollment/PFX/Replace Creates management jobs to install a newly enrolled pfx into the same certificate stores as the previous certificate
EnrollmentApi EnrollmentRenewPost Post /Enrollment/Renew Performs a renewal based upon the passed in request
EnrollmentApi EnrollmentSettingsIdGet 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 EventHandlerRegistrationGet Get /EventHandlerRegistration Returns all registered event handlers according to the provided filter and output parameters
EventHandlerRegistrationApi EventHandlerRegistrationIdDelete Delete /EventHandlerRegistration/{id} Deletes an event handler
EventHandlerRegistrationApi EventHandlerRegistrationIdGet Get /EventHandlerRegistration/{id} Returns a registered event handler that matches the provided ID
EventHandlerRegistrationApi EventHandlerRegistrationIdPut Put /EventHandlerRegistration/{id} Updates a registered event handler's information
EventHandlerRegistrationApi EventHandlerRegistrationPost Post /EventHandlerRegistration Registers an event handler
ExpirationAlertApi AlertsExpirationGet Get /Alerts/Expiration Gets all expiration alerts according to the provided filter and output parameters
ExpirationAlertApi AlertsExpirationIdDelete Delete /Alerts/Expiration/{id} Delete an expiration alert
ExpirationAlertApi AlertsExpirationIdGet Get /Alerts/Expiration/{id} Get an expiration alert
ExpirationAlertApi AlertsExpirationPost Post /Alerts/Expiration Add an expiration alert
ExpirationAlertApi AlertsExpirationPut Put /Alerts/Expiration Edit an expiration alert
ExpirationAlertApi AlertsExpirationScheduleGet Get /Alerts/Expiration/Schedule Get the schedule for expiration alerts
ExpirationAlertApi AlertsExpirationSchedulePut Put /Alerts/Expiration/Schedule Edit schedule
ExpirationAlertApi AlertsExpirationTestAllPost Post /Alerts/Expiration/TestAll Test All Expiration Alerts
ExpirationAlertApi AlertsExpirationTestPost Post /Alerts/Expiration/Test Test an Expiration Alert
ExtensionsApi ExtensionsScriptsGet Get /Extensions/Scripts Returns all scripts according to the provided filter and output parameters
ExtensionsApi ExtensionsScriptsIdDelete Delete /Extensions/Scripts/{id} Deletes a script. Script cannot be configured to an alert or workflow.
ExtensionsApi ExtensionsScriptsIdGet Get /Extensions/Scripts/{id} Returns a single script that matches the provided Id
ExtensionsApi ExtensionsScriptsPost Post /Extensions/Scripts Adds a new script
ExtensionsApi ExtensionsScriptsPut Put /Extensions/Scripts Updates a script
IdentityProviderApi IdentityProvidersGet Get /IdentityProviders Returns all OAuth identity providers according to the provided filter and output parameters.
IdentityProviderApi IdentityProvidersIdGet Get /IdentityProviders/{id} Gets an OAuth identity provider and its parameters.
IdentityProviderApi IdentityProvidersIdPut Put /IdentityProviders/{id} Updates an OAuth identity provider and any provided parameters.
IdentityProviderApi IdentityProvidersTypesGet Get /IdentityProviders/Types Returns a list of all available identity provider types and corresponding type parameters.
IssuedAlertApi AlertsIssuedGet Get /Alerts/Issued Gets all issued alerts according to the provided filter and output parameters
IssuedAlertApi AlertsIssuedIdDelete Delete /Alerts/Issued/{id} Delete a issued alert
IssuedAlertApi AlertsIssuedIdGet Get /Alerts/Issued/{id} Get a issued alert
IssuedAlertApi AlertsIssuedPost Post /Alerts/Issued Add a issued alert
IssuedAlertApi AlertsIssuedPut Put /Alerts/Issued Edit a issued alert
IssuedAlertApi AlertsIssuedScheduleGet Get /Alerts/Issued/Schedule Get the schedule for issued alerts
IssuedAlertApi AlertsIssuedSchedulePut Put /Alerts/Issued/Schedule Edit schedule
KeyApi SSHKeysMyKeyGet Get /SSH/Keys/MyKey Returns the current key of the requesting user
KeyApi SSHKeysMyKeyPost Post /SSH/Keys/MyKey Generates an SSH Key Pair for the requesting user.
KeyApi SSHKeysMyKeyPut Put /SSH/Keys/MyKey Updates the requesting user's SSH key
KeyApi SSHKeysUnmanagedDelete Delete /SSH/Keys/Unmanaged Deletes Unmanaged Keys associated with the provided identifiers
KeyApi SSHKeysUnmanagedGet Get /SSH/Keys/Unmanaged Returns Unmanaged SSH keys
KeyApi SSHKeysUnmanagedIdDelete Delete /SSH/Keys/Unmanaged/{id} Deletes Unmanaged Key associated with the provided identifier
KeyApi SSHKeysUnmanagedIdGet Get /SSH/Keys/Unmanaged/{id} Returns an unmanaged SSH key with provided id.
KeyRotationAlertApi AlertsKeyRotationGet Get /Alerts/KeyRotation Gets all key rotation alerts according to the provided filter and output parameters
KeyRotationAlertApi AlertsKeyRotationIdDelete Delete /Alerts/KeyRotation/{id} Delete a key rotation alert
KeyRotationAlertApi AlertsKeyRotationIdGet Get /Alerts/KeyRotation/{id} Get a key rotation alert
KeyRotationAlertApi AlertsKeyRotationPost Post /Alerts/KeyRotation Add a key rotation alert
KeyRotationAlertApi AlertsKeyRotationPut Put /Alerts/KeyRotation Edit a key rotation alert
KeyRotationAlertApi AlertsKeyRotationScheduleGet Get /Alerts/KeyRotation/Schedule Get the schedule for key rotation alerts
KeyRotationAlertApi AlertsKeyRotationSchedulePut Put /Alerts/KeyRotation/Schedule Edit schedule
KeyRotationAlertApi AlertsKeyRotationTestAllPost Post /Alerts/KeyRotation/TestAll Test All Alerts
KeyRotationAlertApi AlertsKeyRotationTestPost Post /Alerts/KeyRotation/Test Test An Alert
LicenseApi LicenseGet Get /License Gets the current license
LogonApi SSHLogonsAccessPost Post /SSH/Logons/Access Updates the users with access to an existing logon
LogonApi SSHLogonsGet Get /SSH/Logons Returns all Logons according to the provided filter parameters
LogonApi SSHLogonsIdDelete Delete /SSH/Logons/{id} Deletes a Logon associated with the provided identifier
LogonApi SSHLogonsIdGet Get /SSH/Logons/{id} Fetches a Logon associated with the provided identifier
LogonApi SSHLogonsPost Post /SSH/Logons Creates a logon with the provided properties
MacEnrollmentApi MacEnrollmentGet Get /MacEnrollment Gets mac enrollment settings data
MacEnrollmentApi MacEnrollmentPut Put /MacEnrollment Updates mac enrollment settings data
MetadataFieldApi MetadataFieldsDelete Delete /MetadataFields Deletes multiple persisted metadata field types by their unique ids
MetadataFieldApi MetadataFieldsGet Get /MetadataFields Returns all metadata field types according to the provided filter and output parameters
MetadataFieldApi MetadataFieldsIdDelete Delete /MetadataFields/{id} Deletes a persisted metadata field type by its unique id
MetadataFieldApi MetadataFieldsIdGet Get /MetadataFields/{id} Gets a persisted metadata field type by its unique id
MetadataFieldApi MetadataFieldsIdInUseGet Get /MetadataFields/{id}/InUse Determines if a metadata field type associated with the provided identifier is currently in use
MetadataFieldApi MetadataFieldsNameGet Get /MetadataFields/{name} Gets a persisted metadata field type by its unique name
MetadataFieldApi MetadataFieldsPost Post /MetadataFields Creates a new metadata field type with the given metadata field type properties
MetadataFieldApi MetadataFieldsPut Put /MetadataFields Updates a persisted metadata field with the given metadata field type
MonitoringApi MonitoringResolveOCSPPost Post /Monitoring/ResolveOCSP Resolve the Certificate authority given
MonitoringApi MonitoringRevocationGet Get /Monitoring/Revocation Gets all revocation monitoring endpoints according to the provided filter and output parameters
MonitoringApi MonitoringRevocationIdDelete Delete /Monitoring/Revocation/{id} Delete a revocation monitoring endpoint
MonitoringApi MonitoringRevocationIdGet Get /Monitoring/Revocation/{id} Get a revocation monitoring endpoint
MonitoringApi MonitoringRevocationPost Post /Monitoring/Revocation Add a revocation monitoring endpoint
MonitoringApi MonitoringRevocationPut Put /Monitoring/Revocation Edit a revocation monitoring endpoint
MonitoringApi MonitoringRevocationTestAllPost Post /Monitoring/Revocation/TestAll Test All Alerts
MonitoringApi MonitoringRevocationTestPost Post /Monitoring/Revocation/Test Test Alert
OrchestratorJobApi OrchestratorJobsAcknowledgePost Post /OrchestratorJobs/Acknowledge Acknowledges orchestrator jobs based on the provided information
OrchestratorJobApi OrchestratorJobsCustomBulkPost Post /OrchestratorJobs/Custom/Bulk Schedules the same job for a custom JobType on the specified agents using the provided information
OrchestratorJobApi OrchestratorJobsCustomPost Post /OrchestratorJobs/Custom Schedules a job for a custom JobType on the agent using the provided information
OrchestratorJobApi OrchestratorJobsJobHistoryGet Get /OrchestratorJobs/JobHistory Returns all histories of an orchestrator job according to the provided filter and output parameters
OrchestratorJobApi OrchestratorJobsJobStatusDataGet Get /OrchestratorJobs/JobStatus/Data Retrieves the results of a custom job using the provided information
OrchestratorJobApi OrchestratorJobsReschedulePost Post /OrchestratorJobs/Reschedule Reschedules orchestrator jobs based on the provided information
OrchestratorJobApi OrchestratorJobsScheduledJobsGet Get /OrchestratorJobs/ScheduledJobs Returns all scheduled orchestrator jobs according to the provided filter and output parameters
OrchestratorJobApi OrchestratorJobsUnschedulePost Post /OrchestratorJobs/Unschedule Unschedules orchestrator jobs based on the provided information
PAMProviderApi PamProvidersGet Get /PamProviders Returns all PAM providers according to the provided filter and output parameters
PAMProviderApi PamProvidersIdDelete Delete /PamProviders/{id} Deletes a PAM Provider
PAMProviderApi PamProvidersIdGet Get /PamProviders/{id} Returns a single PAM Provider that matches the associated id
PAMProviderApi PamProvidersPost Post /PamProviders Creates a new PAM provider with the associated properties
PAMProviderApi PamProvidersPut Put /PamProviders Updates an existing PAM provider according to the provided properties
PAMProviderApi PamProvidersTypesGet Get /PamProviders/Types Returns all PAM providers in the Keyfactor instance
PAMProviderApi PamProvidersTypesPost Post /PamProviders/Types Creates a new PAM provider type with the associated properties
PendingAlertApi AlertsPendingGet Get /Alerts/Pending Gets all pending alerts according to the provided filter and output parameters
PendingAlertApi AlertsPendingIdDelete Delete /Alerts/Pending/{id} Delete a pending alert
PendingAlertApi AlertsPendingIdGet Get /Alerts/Pending/{id} Get a pending alert
PendingAlertApi AlertsPendingPost Post /Alerts/Pending Add a pending alert
PendingAlertApi AlertsPendingPut Put /Alerts/Pending Edit a pending alert
PendingAlertApi AlertsPendingScheduleGet Get /Alerts/Pending/Schedule Get the schedule for pending alerts
PendingAlertApi AlertsPendingSchedulePut Put /Alerts/Pending/Schedule Edit schedule
PendingAlertApi AlertsPendingTestAllPost Post /Alerts/Pending/TestAll Test all pending alerts. Will send alert emails if SendAlerts is true
PendingAlertApi AlertsPendingTestPost Post /Alerts/Pending/Test Test pending alert. Will send alert emails if SendAlerts is true
PermissionSetApi PermissionSetsGet Get /PermissionSets Gets all permission sets in the system.
PermissionSetApi PermissionSetsIdDelete Delete /PermissionSets/{id} Deletes a permission set.
PermissionSetApi PermissionSetsIdGet Get /PermissionSets/{id} Gets permission set data.
PermissionSetApi PermissionSetsPost Post /PermissionSets Creates a new permission set.
PermissionSetApi PermissionSetsPut Put /PermissionSets
PermissionsApi PermissionsGet Get /Permissions Gets all permissions in the system.
ReportsApi ReportsCustomGet Get /Reports/Custom Returns all custom reports according to the provided filter and output parameters
ReportsApi ReportsCustomIdDelete Delete /Reports/Custom/{id} Delete custom report that matches the id
ReportsApi ReportsCustomIdGet Get /Reports/Custom/{id} Returns a single custom report that matches the id
ReportsApi ReportsCustomPost Post /Reports/Custom Creates a custom report
ReportsApi ReportsCustomPut Put /Reports/Custom Updates a custom report that matches the id
ReportsApi ReportsGet Get /Reports Returns all built-in reports according to the provided filter and output parameters
ReportsApi ReportsIdGet Get /Reports/{id} Returns a single built-in report that matches the id
ReportsApi ReportsIdParametersGet Get /Reports/{id}/Parameters Get a built-in report's parameters that matches the id of the report.
ReportsApi ReportsIdParametersPut Put /Reports/{id}/Parameters Update a built-in report's parameters that matches the id of the report.
ReportsApi ReportsIdSchedulesGet Get /Reports/{id}/Schedules Get a built-in report's schedules that matches the id of the report.
ReportsApi ReportsIdSchedulesPost Post /Reports/{id}/Schedules Create a built-in report's schedule that matches the id of the report.
ReportsApi ReportsIdSchedulesPut Put /Reports/{id}/Schedules Update a built-in report's schedule that matches the id of the report.
ReportsApi ReportsPut Put /Reports Updates a single built-in report that matches the id. Only some fields can be updated.
ReportsApi ReportsSchedulesIdDelete Delete /Reports/Schedules/{id} Delete a built-in report's schedule that matches the id of the schedule.
ReportsApi ReportsSchedulesIdGet Get /Reports/Schedules/{id} Get a built-in report's schedule that matches the id of the schedule.
SMTPApi SMTPGet Get /SMTP Gets SMTP profile data
SMTPApi SMTPPut Put /SMTP Updates SMTP profile data
SMTPApi SMTPTestPost Post /SMTP/Test Tests SMTP profile data
SchedulingApi SchedulingPost Post /Scheduling
SecurityApi SecurityAuditCollectionsIdGet Get /Security/Audit/Collections/{id} Gets a list of applicable security permissions for certificate collection
SecurityApi SecurityContainersIdRolesGet Get /Security/Containers/{id}/Roles Returns all the permissions of a certificate store container through the id
SecurityApi SecurityContainersIdRolesPost Post /Security/Containers/{id}/Roles Edit a certificate store container's permissions. Reminder: Name field should be left blank.
SecurityApi SecurityIdentitiesGet Get /Security/Identities Returns all security identities according to the provided filter and output parameters.
SecurityApi SecurityIdentitiesIdDelete Delete /Security/Identities/{id} Deletes the security identity whose ID is provided.
SecurityApi SecurityIdentitiesIdGet Get /Security/Identities/{id} Gets an object representing the permissions of the identity associated with the provided identifier.
SecurityApi SecurityIdentitiesLookupGet Get /Security/Identities/Lookup Validates that the identity with the name given exists.
SecurityApi SecurityIdentitiesPost Post /Security/Identities Adds a new security identity to the system.
SecurityApi SecurityMyGet Get /Security/My Looks at all the roles and global permissions for the user and returns them.
SecurityClaimsApi SecurityClaimsGet Get /Security/Claims Returns all claim definitions according to the provided filter and output parameters.
SecurityClaimsApi SecurityClaimsIdDelete Delete /Security/Claims/{id} Removes a claim definition from the system.
SecurityClaimsApi SecurityClaimsIdGet Get /Security/Claims/{id} Returns a single claim definition that matches the id.
SecurityClaimsApi SecurityClaimsPost Post /Security/Claims Adds a new claim definition to the system.
SecurityClaimsApi SecurityClaimsPut Put /Security/Claims Updates an existing claim definition.
SecurityClaimsApi SecurityClaimsRolesGet Get /Security/Claims/Roles Returns a list of roles granted by the claim with the provided id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsCollectionsGet Get /Security/Roles/{id}/Permissions/Collections Returns all collection permissions associated with the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsCollectionsPost Post /Security/Roles/{id}/Permissions/Collections Adds collection permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsCollectionsPut Put /Security/Roles/{id}/Permissions/Collections Sets collection permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsContainersGet Get /Security/Roles/{id}/Permissions/Containers Returns all container permissions associated with the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsContainersPost Post /Security/Roles/{id}/Permissions/Containers Adds container permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsContainersPut Put /Security/Roles/{id}/Permissions/Containers Sets container permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsGet Get /Security/Roles/{id}/Permissions Returns all permissions associated with the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsGlobalGet Get /Security/Roles/{id}/Permissions/Global Returns all global permissions associated with the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsGlobalPost Post /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsGlobalPut Put /Security/Roles/{id}/Permissions/Global Adds global permissions to the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsPamProvidersGet Get /Security/Roles/{id}/Permissions/PamProviders Returns all PAM provider permissions associated with the security role that matches the id.
SecurityRolePermissionsApi SecurityRolesIdPermissionsPamProvidersPut Put /Security/Roles/{id}/Permissions/PamProviders Sets PAM provider permissions to the security role that matches the id.
SecurityRolesApi SecurityRolesGet 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 SecurityRolesIdCopyPost 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 SecurityRolesIdDelete Delete /Security/Roles/{id} Deletes the security role whose ID is provided.
SecurityRolesApi SecurityRolesIdGet 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 SecurityRolesIdIdentitiesGet 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 SecurityRolesIdIdentitiesPut 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.
SecurityRolesApi SecurityRolesPost 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 SecurityRolesPut 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.
ServerApi SSHServersAccessDelete Delete /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi SSHServersAccessIdGet Get /SSH/Servers/Access/{id} Retrieves logons and users with access to those logons for an existing server
ServerApi SSHServersAccessPost Post /SSH/Servers/Access Updates logons and users with access to those logons for an existing server
ServerApi SSHServersGet Get /SSH/Servers Returns all servers according to the provided filter parameters
ServerApi SSHServersIdDelete Delete /SSH/Servers/{id} Deletes a Server associated with the provided identifier
ServerApi SSHServersIdGet Get /SSH/Servers/{id} Returns a Server associated with the provided identifier
ServerApi SSHServersPost Post /SSH/Servers Creates a server with the provided properties
ServerApi SSHServersPut Put /SSH/Servers Updates an existing server with the provided properties
ServerGroupApi SSHServerGroupsAccessDelete Delete /SSH/ServerGroups/Access Removes access mappings for the specified server group
ServerGroupApi SSHServerGroupsAccessIdGet Get /SSH/ServerGroups/Access/{id} Retrieves logons and users with access to those logons for an existing server group
ServerGroupApi SSHServerGroupsAccessPost Post /SSH/ServerGroups/Access Add access rules to the server group
ServerGroupApi SSHServerGroupsGet Get /SSH/ServerGroups Returns all server groups according to the provided filter parameters
ServerGroupApi SSHServerGroupsIdDelete Delete /SSH/ServerGroups/{id} Deletes a ServerGroup associated with the provided identifier
ServerGroupApi SSHServerGroupsIdGet Get /SSH/ServerGroups/{id} Returns a ServerGroup associated with the provided identifier
ServerGroupApi SSHServerGroupsNameGet Get /SSH/ServerGroups/{name} Returns a ServerGroup associated with the provided identifier
ServerGroupApi SSHServerGroupsPost Post /SSH/ServerGroups Creates a server group with the provided properties
ServerGroupApi SSHServerGroupsPut Put /SSH/ServerGroups Updates an existing server group with the provided properties
ServiceAccountApi SSHServiceAccountsDelete Delete /SSH/ServiceAccounts Deletes Service Accounts associated with the provided identifiers
ServiceAccountApi SSHServiceAccountsGet Get /SSH/ServiceAccounts Returns all ServiceAccounts according to the provided filter parameters
ServiceAccountApi SSHServiceAccountsIdDelete Delete /SSH/ServiceAccounts/{id} Deletes a ServiceAccount associated with the provided identifier
ServiceAccountApi SSHServiceAccountsIdGet Get /SSH/ServiceAccounts/{id} Returns a ServiceAccount associated with the provided identifier
ServiceAccountApi SSHServiceAccountsKeyIdGet Get /SSH/ServiceAccounts/Key/{id} Returns an SSH key with or without private key based on the provided parameters.
ServiceAccountApi SSHServiceAccountsPost Post /SSH/ServiceAccounts Creates a ServiceAccount with the provided properties
ServiceAccountApi SSHServiceAccountsPut Put /SSH/ServiceAccounts Updates an SSH key for a specified service account.
ServiceAccountApi SSHServiceAccountsRotateIdPost Post /SSH/ServiceAccounts/Rotate/{id} Rotate an SSH key for a specified service account.
SslApi SSLEndpointsIdGet Get /SSL/Endpoints/{id} Returns the details of the associated scanning endpoint
SslApi SSLEndpointsIdHistoryGet 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 SSLEndpointsMonitorAllPut Put /SSL/Endpoints/MonitorAll Sets all endpoints matching the provided query as 'monitored'
SslApi SSLEndpointsMonitorStatusPut Put /SSL/Endpoints/MonitorStatus Sets the monitored status according to the provided endpoint and boolean status
SslApi SSLEndpointsReviewAllPut Put /SSL/Endpoints/ReviewAll Sets all endpoints matching the provided query as 'reviewed'
SslApi SSLEndpointsReviewStatusPut Put /SSL/Endpoints/ReviewStatus Sets the reviewed status according to the provided endpoint and boolean status
SslApi SSLGet Get /SSL Returns a list of the endpoint scan results according to the provided filter and output parameters
SslApi SSLNetworkRangesIdDelete Delete /SSL/NetworkRanges/{id} Removes all network range definitions from the associated network definition
SslApi SSLNetworkRangesIdGet Get /SSL/NetworkRanges/{id} Returns the network range definitions for the provided network definition
SslApi SSLNetworkRangesPost Post /SSL/NetworkRanges Adds the provided network range definitions to the associated network definition
SslApi SSLNetworkRangesPut Put /SSL/NetworkRanges Configures network range definitions for the provided network
SslApi SSLNetworkRangesValidatePost Post /SSL/NetworkRanges/Validate Validates the format (using regular expressions) of the provided network range definitions
SslApi SSLNetworksGet Get /SSL/Networks Returns all defined SSL networks according to the provided filter and output parameters
SslApi SSLNetworksIdDelete Delete /SSL/Networks/{id} Removes a network definition according to the provided identifier
SslApi SSLNetworksIdPartsGet Get /SSL/Networks/{id}/Parts Returns the scan job components comprising the entire scan job to be executed
SslApi SSLNetworksIdResetPost Post /SSL/Networks/{id}/Reset Resets all SSL scans associated with a network
SslApi SSLNetworksIdScanPost Post /SSL/Networks/{id}/Scan Starts an SSL Scan for the network according to the associated network definition
SslApi SSLNetworksIdentifierGet Get /SSL/Networks/{identifier} Returns a defined SSL network according to the provided name
SslApi SSLNetworksPost Post /SSL/Networks Creates a network definition according to the provided properties
SslApi SSLNetworksPut Put /SSL/Networks Updates an existing network definition according to the provided properties
SslApi SSLPartsIdGet Get /SSL/Parts/{id} Returns the execution details of the associated network scan job part
StatusApi StatusEndpointsGet Get /Status/Endpoints Returns all endpoints to which the requesting identity has access
TemplateApi TemplatesGet Get /Templates Returns all certificate templates according to the provided filter and output parameters
TemplateApi TemplatesIdGet Get /Templates/{id} Returns the certificate template associated with the provided id
TemplateApi TemplatesImportPost Post /Templates/Import Imports templates from the provided configuration tenant
TemplateApi TemplatesPut Put /Templates Updates a certificate template according to the provided properties
TemplateApi TemplatesSettingsGet Get /Templates/Settings Gets the global template settings.
TemplateApi TemplatesSettingsPut Put /Templates/Settings Replaces the existing global template settings.
TemplateApi TemplatesSubjectPartsGet Get /Templates/SubjectParts
UserApi SSHUsersAccessPost Post /SSH/Users/Access Updates logon access for a user
UserApi SSHUsersGet Get /SSH/Users Returns users matching the criteria from the provided query parameters
UserApi SSHUsersIdDelete Delete /SSH/Users/{id} Deletes an SSH user.
UserApi SSHUsersIdGet Get /SSH/Users/{id} Looks up information about an existing SSH user.
UserApi SSHUsersPost Post /SSH/Users Creates a new SSH User.
UserApi SSHUsersPut Put /SSH/Users Updates information about a given user.
WorkflowApi WorkflowCertificatesApprovePost Post /Workflow/Certificates/Approve Approves pending certificate requests associated with the provided ids
WorkflowApi WorkflowCertificatesDeniedGet Get /Workflow/Certificates/Denied Gets a collection of denied certificate requests based on the provided query.
WorkflowApi WorkflowCertificatesDenyPost Post /Workflow/Certificates/Deny Denies pending certificate requests associated with the provided ids
WorkflowApi WorkflowCertificatesExternalValidationGet Get /Workflow/Certificates/ExternalValidation Gets a collection of external validation certificate requests based on the provided query.
WorkflowApi WorkflowCertificatesIdGet Get /Workflow/Certificates/{id} Returns certificate request details based on the provided ID.
WorkflowApi WorkflowCertificatesPendingGet Get /Workflow/Certificates/Pending Gets a collection of pending certificate requests based on the provided query.
WorkflowDefinitionApi WorkflowDefinitionsDefinitionIdDelete Delete /Workflow/Definitions/{definitionId} Deletes the definition matching the given Id.
WorkflowDefinitionApi WorkflowDefinitionsDefinitionIdGet Get /Workflow/Definitions/{definitionId} Gets a workflow definition.
WorkflowDefinitionApi WorkflowDefinitionsDefinitionIdPublishPost Post /Workflow/Definitions/{definitionId}/Publish Makes the most recent version of a Workflow Definition the published version.
WorkflowDefinitionApi WorkflowDefinitionsDefinitionIdPut Put /Workflow/Definitions/{definitionId} Updates the existing definition's DisplayName and Description.
WorkflowDefinitionApi WorkflowDefinitionsDefinitionIdStepsPut Put /Workflow/Definitions/{definitionId}/Steps Sets the provided steps on the latest version of the definition.
WorkflowDefinitionApi WorkflowDefinitionsGet Get /Workflow/Definitions Gets the Definitions matching the query specifications.
WorkflowDefinitionApi WorkflowDefinitionsPost Post /Workflow/Definitions Creates a new base definition without any steps.
WorkflowDefinitionApi WorkflowDefinitionsStepsExtensionNameGet Get /Workflow/Definitions/Steps/{extensionName} Gets the schema of a given step with the specified extension name.
WorkflowDefinitionApi WorkflowDefinitionsStepsGet Get /Workflow/Definitions/Steps Gets the result set of available steps for a given query.
WorkflowDefinitionApi WorkflowDefinitionsTypesGet Get /Workflow/Definitions/Types Performs a query against the workflow types in the system.
WorkflowInstanceApi WorkflowInstancesAssignedToMeGet Get /Workflow/Instances/AssignedToMe Gets the workflow instances waiting on the user.
WorkflowInstanceApi WorkflowInstancesGet Get /Workflow/Instances Gets the workflow instances matching the query specifications.
WorkflowInstanceApi WorkflowInstancesInstanceIdDelete Delete /Workflow/Instances/{instanceId} Deletes the specified instance.
WorkflowInstanceApi WorkflowInstancesInstanceIdGet Get /Workflow/Instances/{instanceId} Get information relevant for knowing where an instance is in its workflow.
WorkflowInstanceApi WorkflowInstancesInstanceIdRestartPost Post /Workflow/Instances/{instanceId}/Restart Restarts a failed instance against the specified definition version or the published version if no version is specified.
WorkflowInstanceApi WorkflowInstancesInstanceIdSignalsPost Post /Workflow/Instances/{instanceId}/Signals Receives the given signal for the given instance.
WorkflowInstanceApi WorkflowInstancesInstanceIdStopPost Post /Workflow/Instances/{instanceId}/Stop Rejects an instance, preventing it from continuing.
WorkflowInstanceApi WorkflowInstancesMyGet 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

Directories

Path Synopsis
api
command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.