Categorygithub.com/Keyfactor/keyfactor-go-client-sdk/v11

# Packages

No description provided by the author

# 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

ClassMethodHTTP requestDescription
AgentApiAgentsApprovePostPost /Agents/ApproveApprove a list of agents
AgentApiAgentsDisapprovePostPost /Agents/DisapproveDisapprove a list of agents
AgentApiAgentsGetGet /AgentsReturns all agents according to the provided filter and output parameters
AgentApiAgentsIdFetchLogsPostPost /Agents/{id}/FetchLogsSchedules a job on the agent to retrieve log files
AgentApiAgentsIdGetGet /Agents/{id}Returns details for a single agent, specified by ID
AgentApiAgentsIdResetPostPost /Agents/{id}/ResetReset an agent to a new state
AgentApiAgentsResetPostPost /Agents/ResetReset a list of agents
AgentApiAgentsSetAuthCertificateReenrollmentPostPost /Agents/SetAuthCertificateReenrollmentUpdate 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.
AgentBlueprintApiAgentBluePrintApplyBlueprintPostPost /AgentBluePrint/ApplyBlueprintApplies the selected agent blueprint to the provided agents
AgentBlueprintApiAgentBluePrintGenerateBluePrintPostPost /AgentBluePrint/GenerateBluePrintGenerates an agent blueprint from the provided agents
AgentBlueprintApiAgentBluePrintGetGet /AgentBluePrintReturns all agent blueprints according to the provided filter and output parameters
AgentBlueprintApiAgentBluePrintIdDeleteDelete /AgentBluePrint/{id}Deletes an agent blueprint by its Keyfactor identifier
AgentBlueprintApiAgentBluePrintIdGetGet /AgentBluePrint/{id}Returns an agent blueprint according to the provided filter and output parameters
AgentBlueprintApiAgentBluePrintIdJobsGetGet /AgentBluePrint/{id}/JobsGets the agent blueprint scheduled jobs
AgentBlueprintApiAgentBluePrintIdStoresGetGet /AgentBluePrint/{id}/StoresGets the agent blueprint certificate stores
AgentPoolApiAgentPoolsAgentsGetGet /AgentPools/AgentsReturns all agents for the default agent pool
AgentPoolApiAgentPoolsGetGet /AgentPoolsReturns all agent pools according to the provided filter and output parameters
AgentPoolApiAgentPoolsIdDeleteDelete /AgentPools/{id}Deletes the agent pool associated with the provided id
AgentPoolApiAgentPoolsIdGetGet /AgentPools/{id}Returns a single agent pool associated with the provided id
AgentPoolApiAgentPoolsPostPost /AgentPoolsCreates an agent pool with the provided properties
AgentPoolApiAgentPoolsPutPut /AgentPoolsUpdates an existing agent pool with the provided properties
AppSettingApiAppSettingGetGet /AppSettingGet available application settings
AppSettingApiAppSettingIdGetGet /AppSetting/{id}Get application setting by id
AppSettingApiAppSettingIdSetPutPut /AppSetting/{id}/SetUpdate one application setting by id
AppSettingApiAppSettingNameSetPutPut /AppSetting/{name}/SetUpdate one application setting by short name
AppSettingApiAppSettingPutPut /AppSettingBulk update available application settings
AuditLogApiAuditDownloadGetGet /Audit/DownloadReturns a Comma Separated file containing the audit log entries according to the provided filter
AuditLogApiAuditGetGet /AuditReturns all audit log entries according to the provided filter and output parameters
AuditLogApiAuditIdGetGet /Audit/{id}Returns the audit log entry associated with the provided identifier
AuditLogApiAuditIdValidateGetGet /Audit/{id}/ValidateValidates the audit log entry associated with the provided keyfactor id
AuditLogApiAuditRelatedEntitiesGetGet /Audit/RelatedEntitiesReturns the audit log entry associated with the provided keyfactor id
CSRGenerationApiCSRGenerationGeneratePostPost /CSRGeneration/GenerateGenerates a CSR according the properties provided
CSRGenerationApiCSRGenerationPendingDeleteDelete /CSRGeneration/PendingDeletes the CSRs associated with the provided identifiers
CSRGenerationApiCSRGenerationPendingGetGet /CSRGeneration/PendingReturns a list of the currently pending CSRs according to the provided query
CSRGenerationApiCSRGenerationPendingIdDeleteDelete /CSRGeneration/Pending/{id}Deletes a CSR associated with the provided identifier
CSRGenerationApiCSRGenerationPendingIdGetGet /CSRGeneration/Pending/{id}Returns a previously generated CSR associated with the provided identifier
CertificateApiCertificatesAnalyzePostPost /Certificates/AnalyzeReturns the public information of the certificate
CertificateApiCertificatesCSVGetGet /Certificates/CSVReturns a comma-delimited CSV file containing all certificates in the database
CertificateApiCertificatesDeleteDelete /CertificatesDeletes multiple persisted certificates by their unique ids
CertificateApiCertificatesDownloadPostPost /Certificates/DownloadDownloads the persisted certificate associated with the provided query
CertificateApiCertificatesGetGet /CertificatesReturns all certificates according to the provided filter and output parameters
CertificateApiCertificatesIdDeleteDelete /Certificates/{id}Deletes a persisted certificate by its unique id as well as the stored private key (if present) associated with it
CertificateApiCertificatesIdGetGet /Certificates/{id}Returns a single certificate that matches the id
CertificateApiCertificatesIdHistoryGetGet /Certificates/{id}/HistoryGets the history of operations on a certificate
CertificateApiCertificatesIdSecurityGetGet /Certificates/{id}/SecurityGets the list of Security Identities and which permissions they have on the given certificate.
CertificateApiCertificatesIdValidateGetGet /Certificates/{id}/ValidateValidates the certificate chain can be built.
CertificateApiCertificatesIdentityAuditIdGetGet /Certificates/IdentityAudit/{id}Audit identity permissions for certificate
CertificateApiCertificatesImportPostPost /Certificates/ImportImports the provided certificate into the Keyfactor instance, including any provided associated data
CertificateApiCertificatesLocationsIdGetGet /Certificates/Locations/{id}Returns a list of locations the certificate is in
CertificateApiCertificatesMetadataAllPutPut /Certificates/Metadata/AllUpdates the metadata for certificates associated with the certificate identifiers or query provided
CertificateApiCertificatesMetadataCompareGetGet /Certificates/Metadata/CompareCompares the metadata value provided with the metadata value associated with the specified certificate
CertificateApiCertificatesMetadataPutPut /Certificates/MetadataUpdates the metadata for the certificate associated with the identifier provided
CertificateApiCertificatesPrivateKeyDeleteDelete /Certificates/PrivateKeyDeletes the persisted private keys of multiple certificates by the unique ids of the Certificates
CertificateApiCertificatesPrivateKeyIdDeleteDelete /Certificates/PrivateKey/{id}Deletes the persisted private key of the certificate associated with the provided identifier
CertificateApiCertificatesQueryDeleteDelete /Certificates/QueryDeletes multiple persisted certificate entities selected by a given query
CertificateApiCertificatesRecoverPostPost /Certificates/RecoverRecovers the persisted certificate associated with the provided query
CertificateApiCertificatesRevokePostPost /Certificates/RevokeRevokes the certificates associated with the provided identifiers and associates the provided data with the revocation
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAHealthRecipientsGetGet /CertificateAuthority/AlertRecipients/CAHealthRecipientsReturns a list of all CA health recipients
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAHealthRecipientsIdDeleteDelete /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id}Deletes a CA health recipient for the provided ID
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAHealthRecipientsIdGetGet /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id}Returns a CA health recipient for the specified health recipient ID
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAHealthRecipientsIdPutPut /CertificateAuthority/AlertRecipients/CAHealthRecipients/{id}Updates a CA health alert recipient for the provided request object
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAHealthRecipientsPostPost /CertificateAuthority/AlertRecipients/CAHealthRecipientsCreates CA health monitoring recipients for the provided list of email addresses"
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAThresholdRecipientsGetGet /CertificateAuthority/AlertRecipients/CAThresholdRecipientsReturns a list of all CA threshold recipients
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAThresholdRecipientsIdDeleteDelete /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id}Deletes a CA threshold recipient for the provided ID
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAThresholdRecipientsIdGetGet /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id}Returns a CA threshold recipient for the specified threshold alert recipient ID
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAThresholdRecipientsIdPutPut /CertificateAuthority/AlertRecipients/CAThresholdRecipients/{id}Updates a CA threshold alert recipient for the provided request object
CertificateAuthorityApiCertificateAuthorityAlertRecipientsCAThresholdRecipientsPostPost /CertificateAuthority/AlertRecipients/CAThresholdRecipientsCreates CA threshold alert recipients for the provided list of emails
CertificateAuthorityApiCertificateAuthorityAvailableForestsGetGet /CertificateAuthority/AvailableForestsReturns a list of available forests that are in active directory
CertificateAuthorityApiCertificateAuthorityGetGet /CertificateAuthorityReturns all certificate authorities according to the provided filter
CertificateAuthorityApiCertificateAuthorityHealthMonitoringScheduleGetGet /CertificateAuthority/HealthMonitoring/ScheduleRetrieves the execution schedule for the CA health monitoring job
CertificateAuthorityApiCertificateAuthorityIdDeleteDelete /CertificateAuthority/{id}Deletes a CertificateAuthority from the system, specified by ID
CertificateAuthorityApiCertificateAuthorityIdGetGet /CertificateAuthority/{id}Returns details for a single CA, specified by ID
CertificateAuthorityApiCertificateAuthorityImportPostPost /CertificateAuthority/ImportImports any certificate authorities from the provided configuration tenant DNS
CertificateAuthorityApiCertificateAuthorityPostPost /CertificateAuthorityCreates a new CertificateAuthority object
CertificateAuthorityApiCertificateAuthorityPublishCRLPostPost /CertificateAuthority/PublishCRLPublishes a CRL according to the provided request
CertificateAuthorityApiCertificateAuthorityPutPut /CertificateAuthorityUpdates a CertificateAuthority object
CertificateAuthorityApiCertificateAuthoritySourceCountGetGet /CertificateAuthority/SourceCountReturns a count of certificate authorities with sync enabled
CertificateAuthorityApiCertificateAuthorityTestPostPost /CertificateAuthority/TestValidates the connection info for the CA provided by the model.
CertificateCollectionApiCertificateCollectionsCollectionListGetGet /CertificateCollections/CollectionListGet certificate collection list with duplication field name
CertificateCollectionApiCertificateCollectionsCopyPostPost /CertificateCollections/CopyCreates 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.
CertificateCollectionApiCertificateCollectionsGetGet /CertificateCollectionsReturns all certificate collections
CertificateCollectionApiCertificateCollectionsIdDeleteDelete /CertificateCollections/{id}Delete one certificate collection
CertificateCollectionApiCertificateCollectionsIdFavoritePutPut /CertificateCollections/{id}/FavoriteUpdate favorite for one collection
CertificateCollectionApiCertificateCollectionsIdGetGet /CertificateCollections/{id}Returns the certificate collection definition associated with the provided Keyfactor identifier
CertificateCollectionApiCertificateCollectionsNameGetGet /CertificateCollections/{name}Returns the certificate collection associated with the provided collection name
CertificateCollectionApiCertificateCollectionsNavItemsGetGet /CertificateCollections/NavItemsGet the list of navigation items for certificate collection
CertificateCollectionApiCertificateCollectionsPostPost /CertificateCollectionsCreates a new certificate collection with the provided properties
CertificateCollectionApiCertificateCollectionsPutPut /CertificateCollectionsUpdates an existing certificate collection with the provided properties
CertificateStoreApiCertificateStoresApprovePostPost /CertificateStores/ApproveApproves the provided certificate stores to make them available for management
CertificateStoreApiCertificateStoresAssignContainerPutPut /CertificateStores/AssignContainerAssigns the provided certificate stores to the provided container
CertificateStoreApiCertificateStoresCertificatesAddPostPost /CertificateStores/Certificates/AddConfigures a management job to add a certificate to one or more stores with the provided schedule
CertificateStoreApiCertificateStoresCertificatesRemovePostPost /CertificateStores/Certificates/RemoveConfigures a management job to remove a certificate from one or more stores with the provided schedule
CertificateStoreApiCertificateStoresDeleteDelete /CertificateStoresDeletes multiple persisted certificate store entities by their identifiers
CertificateStoreApiCertificateStoresDiscoveryJobPutPut /CertificateStores/DiscoveryJobConfigures a discovery job to locate currently unmanaged certificate stores
CertificateStoreApiCertificateStoresGetGet /CertificateStoresReturns all certificate stores according to the provided filter and output parameters
CertificateStoreApiCertificateStoresIdDeleteDelete /CertificateStores/{id}Deletes a persisted certificate store by its Keyfactor identifier
CertificateStoreApiCertificateStoresIdGetGet /CertificateStores/{id}Returns a single certificate store associated with the provided id
CertificateStoreApiCertificateStoresIdInventoryGetGet /CertificateStores/{id}/InventoryReturns a single certificate store's inventory associated with the provided id
CertificateStoreApiCertificateStoresPasswordPutPut /CertificateStores/PasswordSets a password for the requested certificate store
CertificateStoreApiCertificateStoresPostPost /CertificateStoresCreates a new certificate store with the provided properties
CertificateStoreApiCertificateStoresPutPut /CertificateStoresUpdates a given certificate store with the properties of the provided instance
CertificateStoreApiCertificateStoresReenrollmentPostPost /CertificateStores/ReenrollmentSchedules a certificate store for reenrollment
CertificateStoreApiCertificateStoresSchedulePostPost /CertificateStores/ScheduleCreates an inventory schedule for the provided certificate stores
CertificateStoreApiCertificateStoresServerGetGet /CertificateStores/ServerReturns all certificate store servers according to the provided filter and output parameters
CertificateStoreApiCertificateStoresServerPostPost /CertificateStores/ServerCreates a new certificate store server with the provided properties
CertificateStoreApiCertificateStoresServerPutPut /CertificateStores/ServerUpdates a given certificate store server with the properties of the provided instance
CertificateStoreContainerApiCertificateStoreContainersGetGet /CertificateStoreContainersReturns all certificate store container according to the provided filter and output parameters
CertificateStoreContainerApiCertificateStoreContainersIdDeleteDelete /CertificateStoreContainers/{id}Delete a certificate store container
CertificateStoreContainerApiCertificateStoreContainersIdGetGet /CertificateStoreContainers/{id}Returns a single certificate store container that matches id
CertificateStoreContainerApiCertificateStoreContainersPostPost /CertificateStoreContainersAdd a certificate store container
CertificateStoreContainerApiCertificateStoreContainersPutPut /CertificateStoreContainersEdit a certificate store container
CertificateStoreTypeApiCertificateStoreTypesDeleteDelete /CertificateStoreTypesDeletes certificate store types according to the provided identifiers
CertificateStoreTypeApiCertificateStoreTypesGetGet /CertificateStoreTypesReturns all certificate store types according to the provided filter and output parameters
CertificateStoreTypeApiCertificateStoreTypesIdDeleteDelete /CertificateStoreTypes/{id}Deletes a certificate store type according to the provided identifier
CertificateStoreTypeApiCertificateStoreTypesIdGetGet /CertificateStoreTypes/{id}Returns a single certificate store type that matches id
CertificateStoreTypeApiCertificateStoreTypesNameNameGetGet /CertificateStoreTypes/Name/{name}Returns a single certificate store type that matches the provided short name
CertificateStoreTypeApiCertificateStoreTypesPostPost /CertificateStoreTypesCreates a new certificate store type with the provided properties
CertificateStoreTypeApiCertificateStoreTypesPutPut /CertificateStoreTypesUpdates an existing certificate store type with the provided properties
ComponentInstallationApiComponentInstallationGetGet /ComponentInstallationReturns all Keyfactor component installations.
ComponentInstallationApiComponentInstallationIdDeleteDelete /ComponentInstallation/{id}Deletes the Keyfactor component installation whose ID is provided.
CustomJobTypeApiJobTypesCustomGetGet /JobTypes/CustomReturns all custom job types according to the provided filter and output parameters
CustomJobTypeApiJobTypesCustomIdDeleteDelete /JobTypes/Custom/{id}Deletes the custom job type associated with the provided id
CustomJobTypeApiJobTypesCustomIdGetGet /JobTypes/Custom/{id}Returns a single custom job type associated with the provided id
CustomJobTypeApiJobTypesCustomPostPost /JobTypes/CustomCreates a custom job type with the provided properties
CustomJobTypeApiJobTypesCustomPutPut /JobTypes/CustomUpdates an existing custom job type with the provided properties
DeniedAlertApiAlertsDeniedGetGet /Alerts/DeniedGets all denied alerts according to the provided filter and output parameters
DeniedAlertApiAlertsDeniedIdDeleteDelete /Alerts/Denied/{id}Delete a denied alert
DeniedAlertApiAlertsDeniedIdGetGet /Alerts/Denied/{id}Get a denied alert
DeniedAlertApiAlertsDeniedPostPost /Alerts/DeniedAdd a denied alert
DeniedAlertApiAlertsDeniedPutPut /Alerts/DeniedEdit a denied alert
EnrollmentApiEnrollmentAvailableRenewalIdIdGetGet /Enrollment/AvailableRenewal/Id/{id}Returns the type of renewal available for a given certificate.
EnrollmentApiEnrollmentAvailableRenewalThumbprintThumbprintGetGet /Enrollment/AvailableRenewal/Thumbprint/{thumbprint}Returns the type of renewal available for a given certificate.
EnrollmentApiEnrollmentCSRContextMyGetGet /Enrollment/CSR/Context/MyReturns the list of available CSR enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApiEnrollmentCSRParsePostPost /Enrollment/CSR/ParseParses the provided CSR and returns the properties
EnrollmentApiEnrollmentCSRPostPost /Enrollment/CSRPerforms a CSR Enrollment based upon the provided request
EnrollmentApiEnrollmentPFXContextMyGetGet /Enrollment/PFX/Context/MyReturns the list of available PFX enrollment templates and their associated CA mappings that the calling user has permissions on
EnrollmentApiEnrollmentPFXDeployPostPost /Enrollment/PFX/DeployCreates management jobs to install a newly enrolled pfx in to one or more certificate stores
EnrollmentApiEnrollmentPFXPostPost /Enrollment/PFXPerforms a PFX Enrollment based upon the provided request
EnrollmentApiEnrollmentPFXReplacePostPost /Enrollment/PFX/ReplaceCreates management jobs to install a newly enrolled pfx into the same certificate stores as the previous certificate
EnrollmentApiEnrollmentRenewPostPost /Enrollment/RenewPerforms a renewal based upon the passed in request
EnrollmentApiEnrollmentSettingsIdGetGet /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.
EventHandlerRegistrationApiEventHandlerRegistrationGetGet /EventHandlerRegistrationReturns all registered event handlers according to the provided filter and output parameters
EventHandlerRegistrationApiEventHandlerRegistrationIdDeleteDelete /EventHandlerRegistration/{id}Deletes an event handler
EventHandlerRegistrationApiEventHandlerRegistrationIdGetGet /EventHandlerRegistration/{id}Returns a registered event handler that matches the provided ID
EventHandlerRegistrationApiEventHandlerRegistrationIdPutPut /EventHandlerRegistration/{id}Updates a registered event handler's information
EventHandlerRegistrationApiEventHandlerRegistrationPostPost /EventHandlerRegistrationRegisters an event handler
ExpirationAlertApiAlertsExpirationGetGet /Alerts/ExpirationGets all expiration alerts according to the provided filter and output parameters
ExpirationAlertApiAlertsExpirationIdDeleteDelete /Alerts/Expiration/{id}Delete an expiration alert
ExpirationAlertApiAlertsExpirationIdGetGet /Alerts/Expiration/{id}Get an expiration alert
ExpirationAlertApiAlertsExpirationPostPost /Alerts/ExpirationAdd an expiration alert
ExpirationAlertApiAlertsExpirationPutPut /Alerts/ExpirationEdit an expiration alert
ExpirationAlertApiAlertsExpirationScheduleGetGet /Alerts/Expiration/ScheduleGet the schedule for expiration alerts
ExpirationAlertApiAlertsExpirationSchedulePutPut /Alerts/Expiration/ScheduleEdit schedule
ExpirationAlertApiAlertsExpirationTestAllPostPost /Alerts/Expiration/TestAllTest All Expiration Alerts
ExpirationAlertApiAlertsExpirationTestPostPost /Alerts/Expiration/TestTest an Expiration Alert
ExtensionsApiExtensionsScriptsGetGet /Extensions/ScriptsReturns all scripts according to the provided filter and output parameters
ExtensionsApiExtensionsScriptsIdDeleteDelete /Extensions/Scripts/{id}Deletes a script. Script cannot be configured to an alert or workflow.
ExtensionsApiExtensionsScriptsIdGetGet /Extensions/Scripts/{id}Returns a single script that matches the provided Id
ExtensionsApiExtensionsScriptsPostPost /Extensions/ScriptsAdds a new script
ExtensionsApiExtensionsScriptsPutPut /Extensions/ScriptsUpdates a script
IdentityProviderApiIdentityProvidersGetGet /IdentityProvidersReturns all OAuth identity providers according to the provided filter and output parameters.
IdentityProviderApiIdentityProvidersIdGetGet /IdentityProviders/{id}Gets an OAuth identity provider and its parameters.
IdentityProviderApiIdentityProvidersIdPutPut /IdentityProviders/{id}Updates an OAuth identity provider and any provided parameters.
IdentityProviderApiIdentityProvidersTypesGetGet /IdentityProviders/TypesReturns a list of all available identity provider types and corresponding type parameters.
IssuedAlertApiAlertsIssuedGetGet /Alerts/IssuedGets all issued alerts according to the provided filter and output parameters
IssuedAlertApiAlertsIssuedIdDeleteDelete /Alerts/Issued/{id}Delete a issued alert
IssuedAlertApiAlertsIssuedIdGetGet /Alerts/Issued/{id}Get a issued alert
IssuedAlertApiAlertsIssuedPostPost /Alerts/IssuedAdd a issued alert
IssuedAlertApiAlertsIssuedPutPut /Alerts/IssuedEdit a issued alert
IssuedAlertApiAlertsIssuedScheduleGetGet /Alerts/Issued/ScheduleGet the schedule for issued alerts
IssuedAlertApiAlertsIssuedSchedulePutPut /Alerts/Issued/ScheduleEdit schedule
KeyApiSSHKeysMyKeyGetGet /SSH/Keys/MyKeyReturns the current key of the requesting user
KeyApiSSHKeysMyKeyPostPost /SSH/Keys/MyKeyGenerates an SSH Key Pair for the requesting user.
KeyApiSSHKeysMyKeyPutPut /SSH/Keys/MyKeyUpdates the requesting user's SSH key
KeyApiSSHKeysUnmanagedDeleteDelete /SSH/Keys/UnmanagedDeletes Unmanaged Keys associated with the provided identifiers
KeyApiSSHKeysUnmanagedGetGet /SSH/Keys/UnmanagedReturns Unmanaged SSH keys
KeyApiSSHKeysUnmanagedIdDeleteDelete /SSH/Keys/Unmanaged/{id}Deletes Unmanaged Key associated with the provided identifier
KeyApiSSHKeysUnmanagedIdGetGet /SSH/Keys/Unmanaged/{id}Returns an unmanaged SSH key with provided id.
KeyRotationAlertApiAlertsKeyRotationGetGet /Alerts/KeyRotationGets all key rotation alerts according to the provided filter and output parameters
KeyRotationAlertApiAlertsKeyRotationIdDeleteDelete /Alerts/KeyRotation/{id}Delete a key rotation alert
KeyRotationAlertApiAlertsKeyRotationIdGetGet /Alerts/KeyRotation/{id}Get a key rotation alert
KeyRotationAlertApiAlertsKeyRotationPostPost /Alerts/KeyRotationAdd a key rotation alert
KeyRotationAlertApiAlertsKeyRotationPutPut /Alerts/KeyRotationEdit a key rotation alert
KeyRotationAlertApiAlertsKeyRotationScheduleGetGet /Alerts/KeyRotation/ScheduleGet the schedule for key rotation alerts
KeyRotationAlertApiAlertsKeyRotationSchedulePutPut /Alerts/KeyRotation/ScheduleEdit schedule
KeyRotationAlertApiAlertsKeyRotationTestAllPostPost /Alerts/KeyRotation/TestAllTest All Alerts
KeyRotationAlertApiAlertsKeyRotationTestPostPost /Alerts/KeyRotation/TestTest An Alert
LicenseApiLicenseGetGet /LicenseGets the current license
LogonApiSSHLogonsAccessPostPost /SSH/Logons/AccessUpdates the users with access to an existing logon
LogonApiSSHLogonsGetGet /SSH/LogonsReturns all Logons according to the provided filter parameters
LogonApiSSHLogonsIdDeleteDelete /SSH/Logons/{id}Deletes a Logon associated with the provided identifier
LogonApiSSHLogonsIdGetGet /SSH/Logons/{id}Fetches a Logon associated with the provided identifier
LogonApiSSHLogonsPostPost /SSH/LogonsCreates a logon with the provided properties
MacEnrollmentApiMacEnrollmentGetGet /MacEnrollmentGets mac enrollment settings data
MacEnrollmentApiMacEnrollmentPutPut /MacEnrollmentUpdates mac enrollment settings data
MetadataFieldApiMetadataFieldsDeleteDelete /MetadataFieldsDeletes multiple persisted metadata field types by their unique ids
MetadataFieldApiMetadataFieldsGetGet /MetadataFieldsReturns all metadata field types according to the provided filter and output parameters
MetadataFieldApiMetadataFieldsIdDeleteDelete /MetadataFields/{id}Deletes a persisted metadata field type by its unique id
MetadataFieldApiMetadataFieldsIdGetGet /MetadataFields/{id}Gets a persisted metadata field type by its unique id
MetadataFieldApiMetadataFieldsIdInUseGetGet /MetadataFields/{id}/InUseDetermines if a metadata field type associated with the provided identifier is currently in use
MetadataFieldApiMetadataFieldsNameGetGet /MetadataFields/{name}Gets a persisted metadata field type by its unique name
MetadataFieldApiMetadataFieldsPostPost /MetadataFieldsCreates a new metadata field type with the given metadata field type properties
MetadataFieldApiMetadataFieldsPutPut /MetadataFieldsUpdates a persisted metadata field with the given metadata field type
MonitoringApiMonitoringResolveOCSPPostPost /Monitoring/ResolveOCSPResolve the Certificate authority given
MonitoringApiMonitoringRevocationGetGet /Monitoring/RevocationGets all revocation monitoring endpoints according to the provided filter and output parameters
MonitoringApiMonitoringRevocationIdDeleteDelete /Monitoring/Revocation/{id}Delete a revocation monitoring endpoint
MonitoringApiMonitoringRevocationIdGetGet /Monitoring/Revocation/{id}Get a revocation monitoring endpoint
MonitoringApiMonitoringRevocationPostPost /Monitoring/RevocationAdd a revocation monitoring endpoint
MonitoringApiMonitoringRevocationPutPut /Monitoring/RevocationEdit a revocation monitoring endpoint
MonitoringApiMonitoringRevocationTestAllPostPost /Monitoring/Revocation/TestAllTest All Alerts
MonitoringApiMonitoringRevocationTestPostPost /Monitoring/Revocation/TestTest Alert
OrchestratorJobApiOrchestratorJobsAcknowledgePostPost /OrchestratorJobs/AcknowledgeAcknowledges orchestrator jobs based on the provided information
OrchestratorJobApiOrchestratorJobsCustomBulkPostPost /OrchestratorJobs/Custom/BulkSchedules the same job for a custom JobType on the specified agents using the provided information
OrchestratorJobApiOrchestratorJobsCustomPostPost /OrchestratorJobs/CustomSchedules a job for a custom JobType on the agent using the provided information
OrchestratorJobApiOrchestratorJobsJobHistoryGetGet /OrchestratorJobs/JobHistoryReturns all histories of an orchestrator job according to the provided filter and output parameters
OrchestratorJobApiOrchestratorJobsJobStatusDataGetGet /OrchestratorJobs/JobStatus/DataRetrieves the results of a custom job using the provided information
OrchestratorJobApiOrchestratorJobsReschedulePostPost /OrchestratorJobs/RescheduleReschedules orchestrator jobs based on the provided information
OrchestratorJobApiOrchestratorJobsScheduledJobsGetGet /OrchestratorJobs/ScheduledJobsReturns all scheduled orchestrator jobs according to the provided filter and output parameters
OrchestratorJobApiOrchestratorJobsUnschedulePostPost /OrchestratorJobs/UnscheduleUnschedules orchestrator jobs based on the provided information
PAMProviderApiPamProvidersGetGet /PamProvidersReturns all PAM providers according to the provided filter and output parameters
PAMProviderApiPamProvidersIdDeleteDelete /PamProviders/{id}Deletes a PAM Provider
PAMProviderApiPamProvidersIdGetGet /PamProviders/{id}Returns a single PAM Provider that matches the associated id
PAMProviderApiPamProvidersPostPost /PamProvidersCreates a new PAM provider with the associated properties
PAMProviderApiPamProvidersPutPut /PamProvidersUpdates an existing PAM provider according to the provided properties
PAMProviderApiPamProvidersTypesGetGet /PamProviders/TypesReturns all PAM providers in the Keyfactor instance
PAMProviderApiPamProvidersTypesPostPost /PamProviders/TypesCreates a new PAM provider type with the associated properties
PendingAlertApiAlertsPendingGetGet /Alerts/PendingGets all pending alerts according to the provided filter and output parameters
PendingAlertApiAlertsPendingIdDeleteDelete /Alerts/Pending/{id}Delete a pending alert
PendingAlertApiAlertsPendingIdGetGet /Alerts/Pending/{id}Get a pending alert
PendingAlertApiAlertsPendingPostPost /Alerts/PendingAdd a pending alert
PendingAlertApiAlertsPendingPutPut /Alerts/PendingEdit a pending alert
PendingAlertApiAlertsPendingScheduleGetGet /Alerts/Pending/ScheduleGet the schedule for pending alerts
PendingAlertApiAlertsPendingSchedulePutPut /Alerts/Pending/ScheduleEdit schedule
PendingAlertApiAlertsPendingTestAllPostPost /Alerts/Pending/TestAllTest all pending alerts. Will send alert emails if SendAlerts is true
PendingAlertApiAlertsPendingTestPostPost /Alerts/Pending/TestTest pending alert. Will send alert emails if SendAlerts is true
PermissionSetApiPermissionSetsGetGet /PermissionSetsGets all permission sets in the system.
PermissionSetApiPermissionSetsIdDeleteDelete /PermissionSets/{id}Deletes a permission set.
PermissionSetApiPermissionSetsIdGetGet /PermissionSets/{id}Gets permission set data.
PermissionSetApiPermissionSetsPostPost /PermissionSetsCreates a new permission set.
PermissionSetApiPermissionSetsPutPut /PermissionSets
PermissionsApiPermissionsGetGet /PermissionsGets all permissions in the system.
ReportsApiReportsCustomGetGet /Reports/CustomReturns all custom reports according to the provided filter and output parameters
ReportsApiReportsCustomIdDeleteDelete /Reports/Custom/{id}Delete custom report that matches the id
ReportsApiReportsCustomIdGetGet /Reports/Custom/{id}Returns a single custom report that matches the id
ReportsApiReportsCustomPostPost /Reports/CustomCreates a custom report
ReportsApiReportsCustomPutPut /Reports/CustomUpdates a custom report that matches the id
ReportsApiReportsGetGet /ReportsReturns all built-in reports according to the provided filter and output parameters
ReportsApiReportsIdGetGet /Reports/{id}Returns a single built-in report that matches the id
ReportsApiReportsIdParametersGetGet /Reports/{id}/ParametersGet a built-in report's parameters that matches the id of the report.
ReportsApiReportsIdParametersPutPut /Reports/{id}/ParametersUpdate a built-in report's parameters that matches the id of the report.
ReportsApiReportsIdSchedulesGetGet /Reports/{id}/SchedulesGet a built-in report's schedules that matches the id of the report.
ReportsApiReportsIdSchedulesPostPost /Reports/{id}/SchedulesCreate a built-in report's schedule that matches the id of the report.
ReportsApiReportsIdSchedulesPutPut /Reports/{id}/SchedulesUpdate a built-in report's schedule that matches the id of the report.
ReportsApiReportsPutPut /ReportsUpdates a single built-in report that matches the id. Only some fields can be updated.
ReportsApiReportsSchedulesIdDeleteDelete /Reports/Schedules/{id}Delete a built-in report's schedule that matches the id of the schedule.
ReportsApiReportsSchedulesIdGetGet /Reports/Schedules/{id}Get a built-in report's schedule that matches the id of the schedule.
SMTPApiSMTPGetGet /SMTPGets SMTP profile data
SMTPApiSMTPPutPut /SMTPUpdates SMTP profile data
SMTPApiSMTPTestPostPost /SMTP/TestTests SMTP profile data
SchedulingApiSchedulingPostPost /Scheduling
SecurityApiSecurityAuditCollectionsIdGetGet /Security/Audit/Collections/{id}Gets a list of applicable security permissions for certificate collection
SecurityApiSecurityContainersIdRolesGetGet /Security/Containers/{id}/RolesReturns all the permissions of a certificate store container through the id
SecurityApiSecurityContainersIdRolesPostPost /Security/Containers/{id}/RolesEdit a certificate store container's permissions. Reminder: Name field should be left blank.
SecurityApiSecurityIdentitiesGetGet /Security/IdentitiesReturns all security identities according to the provided filter and output parameters.
SecurityApiSecurityIdentitiesIdDeleteDelete /Security/Identities/{id}Deletes the security identity whose ID is provided.
SecurityApiSecurityIdentitiesIdGetGet /Security/Identities/{id}Gets an object representing the permissions of the identity associated with the provided identifier.
SecurityApiSecurityIdentitiesLookupGetGet /Security/Identities/LookupValidates that the identity with the name given exists.
SecurityApiSecurityIdentitiesPostPost /Security/IdentitiesAdds a new security identity to the system.
SecurityApiSecurityMyGetGet /Security/MyLooks at all the roles and global permissions for the user and returns them.
SecurityClaimsApiSecurityClaimsGetGet /Security/ClaimsReturns all claim definitions according to the provided filter and output parameters.
SecurityClaimsApiSecurityClaimsIdDeleteDelete /Security/Claims/{id}Removes a claim definition from the system.
SecurityClaimsApiSecurityClaimsIdGetGet /Security/Claims/{id}Returns a single claim definition that matches the id.
SecurityClaimsApiSecurityClaimsPostPost /Security/ClaimsAdds a new claim definition to the system.
SecurityClaimsApiSecurityClaimsPutPut /Security/ClaimsUpdates an existing claim definition.
SecurityClaimsApiSecurityClaimsRolesGetGet /Security/Claims/RolesReturns a list of roles granted by the claim with the provided id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsCollectionsGetGet /Security/Roles/{id}/Permissions/CollectionsReturns all collection permissions associated with the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsCollectionsPostPost /Security/Roles/{id}/Permissions/CollectionsAdds collection permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsCollectionsPutPut /Security/Roles/{id}/Permissions/CollectionsSets collection permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsContainersGetGet /Security/Roles/{id}/Permissions/ContainersReturns all container permissions associated with the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsContainersPostPost /Security/Roles/{id}/Permissions/ContainersAdds container permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsContainersPutPut /Security/Roles/{id}/Permissions/ContainersSets container permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsGetGet /Security/Roles/{id}/PermissionsReturns all permissions associated with the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsGlobalGetGet /Security/Roles/{id}/Permissions/GlobalReturns all global permissions associated with the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsGlobalPostPost /Security/Roles/{id}/Permissions/GlobalAdds global permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsGlobalPutPut /Security/Roles/{id}/Permissions/GlobalAdds global permissions to the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsPamProvidersGetGet /Security/Roles/{id}/Permissions/PamProvidersReturns all PAM provider permissions associated with the security role that matches the id.
SecurityRolePermissionsApiSecurityRolesIdPermissionsPamProvidersPutPut /Security/Roles/{id}/Permissions/PamProvidersSets PAM provider permissions to the security role that matches the id.
SecurityRolesApiSecurityRolesGetGet /Security/RolesReturns 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.
SecurityRolesApiSecurityRolesIdCopyPostPost /Security/Roles/{id}/CopyMakes 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.
SecurityRolesApiSecurityRolesIdDeleteDelete /Security/Roles/{id}Deletes the security role whose ID is provided.
SecurityRolesApiSecurityRolesIdGetGet /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.
SecurityRolesApiSecurityRolesIdIdentitiesGetGet /Security/Roles/{id}/IdentitiesReturns 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.
SecurityRolesApiSecurityRolesIdIdentitiesPutPut /Security/Roles/{id}/IdentitiesUpdates 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.
SecurityRolesApiSecurityRolesPostPost /Security/RolesAdds 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.
SecurityRolesApiSecurityRolesPutPut /Security/RolesUpdates 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.
ServerApiSSHServersAccessDeleteDelete /SSH/Servers/AccessUpdates logons and users with access to those logons for an existing server
ServerApiSSHServersAccessIdGetGet /SSH/Servers/Access/{id}Retrieves logons and users with access to those logons for an existing server
ServerApiSSHServersAccessPostPost /SSH/Servers/AccessUpdates logons and users with access to those logons for an existing server
ServerApiSSHServersGetGet /SSH/ServersReturns all servers according to the provided filter parameters
ServerApiSSHServersIdDeleteDelete /SSH/Servers/{id}Deletes a Server associated with the provided identifier
ServerApiSSHServersIdGetGet /SSH/Servers/{id}Returns a Server associated with the provided identifier
ServerApiSSHServersPostPost /SSH/ServersCreates a server with the provided properties
ServerApiSSHServersPutPut /SSH/ServersUpdates an existing server with the provided properties
ServerGroupApiSSHServerGroupsAccessDeleteDelete /SSH/ServerGroups/AccessRemoves access mappings for the specified server group
ServerGroupApiSSHServerGroupsAccessIdGetGet /SSH/ServerGroups/Access/{id}Retrieves logons and users with access to those logons for an existing server group
ServerGroupApiSSHServerGroupsAccessPostPost /SSH/ServerGroups/AccessAdd access rules to the server group
ServerGroupApiSSHServerGroupsGetGet /SSH/ServerGroupsReturns all server groups according to the provided filter parameters
ServerGroupApiSSHServerGroupsIdDeleteDelete /SSH/ServerGroups/{id}Deletes a ServerGroup associated with the provided identifier
ServerGroupApiSSHServerGroupsIdGetGet /SSH/ServerGroups/{id}Returns a ServerGroup associated with the provided identifier
ServerGroupApiSSHServerGroupsNameGetGet /SSH/ServerGroups/{name}Returns a ServerGroup associated with the provided identifier
ServerGroupApiSSHServerGroupsPostPost /SSH/ServerGroupsCreates a server group with the provided properties
ServerGroupApiSSHServerGroupsPutPut /SSH/ServerGroupsUpdates an existing server group with the provided properties
ServiceAccountApiSSHServiceAccountsDeleteDelete /SSH/ServiceAccountsDeletes Service Accounts associated with the provided identifiers
ServiceAccountApiSSHServiceAccountsGetGet /SSH/ServiceAccountsReturns all ServiceAccounts according to the provided filter parameters
ServiceAccountApiSSHServiceAccountsIdDeleteDelete /SSH/ServiceAccounts/{id}Deletes a ServiceAccount associated with the provided identifier
ServiceAccountApiSSHServiceAccountsIdGetGet /SSH/ServiceAccounts/{id}Returns a ServiceAccount associated with the provided identifier
ServiceAccountApiSSHServiceAccountsKeyIdGetGet /SSH/ServiceAccounts/Key/{id}Returns an SSH key with or without private key based on the provided parameters.
ServiceAccountApiSSHServiceAccountsPostPost /SSH/ServiceAccountsCreates a ServiceAccount with the provided properties
ServiceAccountApiSSHServiceAccountsPutPut /SSH/ServiceAccountsUpdates an SSH key for a specified service account.
ServiceAccountApiSSHServiceAccountsRotateIdPostPost /SSH/ServiceAccounts/Rotate/{id}Rotate an SSH key for a specified service account.
SslApiSSLEndpointsIdGetGet /SSL/Endpoints/{id}Returns the details of the associated scanning endpoint
SslApiSSLEndpointsIdHistoryGetGet /SSL/Endpoints/{id}/HistoryReturns a list of the scan results for the provided endpoint according to the provided filter and output parameters
SslApiSSLEndpointsMonitorAllPutPut /SSL/Endpoints/MonitorAllSets all endpoints matching the provided query as 'monitored'
SslApiSSLEndpointsMonitorStatusPutPut /SSL/Endpoints/MonitorStatusSets the monitored status according to the provided endpoint and boolean status
SslApiSSLEndpointsReviewAllPutPut /SSL/Endpoints/ReviewAllSets all endpoints matching the provided query as 'reviewed'
SslApiSSLEndpointsReviewStatusPutPut /SSL/Endpoints/ReviewStatusSets the reviewed status according to the provided endpoint and boolean status
SslApiSSLGetGet /SSLReturns a list of the endpoint scan results according to the provided filter and output parameters
SslApiSSLNetworkRangesIdDeleteDelete /SSL/NetworkRanges/{id}Removes all network range definitions from the associated network definition
SslApiSSLNetworkRangesIdGetGet /SSL/NetworkRanges/{id}Returns the network range definitions for the provided network definition
SslApiSSLNetworkRangesPostPost /SSL/NetworkRangesAdds the provided network range definitions to the associated network definition
SslApiSSLNetworkRangesPutPut /SSL/NetworkRangesConfigures network range definitions for the provided network
SslApiSSLNetworkRangesValidatePostPost /SSL/NetworkRanges/ValidateValidates the format (using regular expressions) of the provided network range definitions
SslApiSSLNetworksGetGet /SSL/NetworksReturns all defined SSL networks according to the provided filter and output parameters
SslApiSSLNetworksIdDeleteDelete /SSL/Networks/{id}Removes a network definition according to the provided identifier
SslApiSSLNetworksIdPartsGetGet /SSL/Networks/{id}/PartsReturns the scan job components comprising the entire scan job to be executed
SslApiSSLNetworksIdResetPostPost /SSL/Networks/{id}/ResetResets all SSL scans associated with a network
SslApiSSLNetworksIdScanPostPost /SSL/Networks/{id}/ScanStarts an SSL Scan for the network according to the associated network definition
SslApiSSLNetworksIdentifierGetGet /SSL/Networks/{identifier}Returns a defined SSL network according to the provided name
SslApiSSLNetworksPostPost /SSL/NetworksCreates a network definition according to the provided properties
SslApiSSLNetworksPutPut /SSL/NetworksUpdates an existing network definition according to the provided properties
SslApiSSLPartsIdGetGet /SSL/Parts/{id}Returns the execution details of the associated network scan job part
StatusApiStatusEndpointsGetGet /Status/EndpointsReturns all endpoints to which the requesting identity has access
TemplateApiTemplatesGetGet /TemplatesReturns all certificate templates according to the provided filter and output parameters
TemplateApiTemplatesIdGetGet /Templates/{id}Returns the certificate template associated with the provided id
TemplateApiTemplatesImportPostPost /Templates/ImportImports templates from the provided configuration tenant
TemplateApiTemplatesPutPut /TemplatesUpdates a certificate template according to the provided properties
TemplateApiTemplatesSettingsGetGet /Templates/SettingsGets the global template settings.
TemplateApiTemplatesSettingsPutPut /Templates/SettingsReplaces the existing global template settings.
TemplateApiTemplatesSubjectPartsGetGet /Templates/SubjectParts
UserApiSSHUsersAccessPostPost /SSH/Users/AccessUpdates logon access for a user
UserApiSSHUsersGetGet /SSH/UsersReturns users matching the criteria from the provided query parameters
UserApiSSHUsersIdDeleteDelete /SSH/Users/{id}Deletes an SSH user.
UserApiSSHUsersIdGetGet /SSH/Users/{id}Looks up information about an existing SSH user.
UserApiSSHUsersPostPost /SSH/UsersCreates a new SSH User.
UserApiSSHUsersPutPut /SSH/UsersUpdates information about a given user.
WorkflowApiWorkflowCertificatesApprovePostPost /Workflow/Certificates/ApproveApproves pending certificate requests associated with the provided ids
WorkflowApiWorkflowCertificatesDeniedGetGet /Workflow/Certificates/DeniedGets a collection of denied certificate requests based on the provided query.
WorkflowApiWorkflowCertificatesDenyPostPost /Workflow/Certificates/DenyDenies pending certificate requests associated with the provided ids
WorkflowApiWorkflowCertificatesExternalValidationGetGet /Workflow/Certificates/ExternalValidationGets a collection of external validation certificate requests based on the provided query.
WorkflowApiWorkflowCertificatesIdGetGet /Workflow/Certificates/{id}Returns certificate request details based on the provided ID.
WorkflowApiWorkflowCertificatesPendingGetGet /Workflow/Certificates/PendingGets a collection of pending certificate requests based on the provided query.
WorkflowDefinitionApiWorkflowDefinitionsDefinitionIdDeleteDelete /Workflow/Definitions/{definitionId}Deletes the definition matching the given Id.
WorkflowDefinitionApiWorkflowDefinitionsDefinitionIdGetGet /Workflow/Definitions/{definitionId}Gets a workflow definition.
WorkflowDefinitionApiWorkflowDefinitionsDefinitionIdPublishPostPost /Workflow/Definitions/{definitionId}/PublishMakes the most recent version of a Workflow Definition the published version.
WorkflowDefinitionApiWorkflowDefinitionsDefinitionIdPutPut /Workflow/Definitions/{definitionId}Updates the existing definition's DisplayName and Description.
WorkflowDefinitionApiWorkflowDefinitionsDefinitionIdStepsPutPut /Workflow/Definitions/{definitionId}/StepsSets the provided steps on the latest version of the definition.
WorkflowDefinitionApiWorkflowDefinitionsGetGet /Workflow/DefinitionsGets the Definitions matching the query specifications.
WorkflowDefinitionApiWorkflowDefinitionsPostPost /Workflow/DefinitionsCreates a new base definition without any steps.
WorkflowDefinitionApiWorkflowDefinitionsStepsExtensionNameGetGet /Workflow/Definitions/Steps/{extensionName}Gets the schema of a given step with the specified extension name.
WorkflowDefinitionApiWorkflowDefinitionsStepsGetGet /Workflow/Definitions/StepsGets the result set of available steps for a given query.
WorkflowDefinitionApiWorkflowDefinitionsTypesGetGet /Workflow/Definitions/TypesPerforms a query against the workflow types in the system.
WorkflowInstanceApiWorkflowInstancesAssignedToMeGetGet /Workflow/Instances/AssignedToMeGets the workflow instances waiting on the user.
WorkflowInstanceApiWorkflowInstancesGetGet /Workflow/InstancesGets the workflow instances matching the query specifications.
WorkflowInstanceApiWorkflowInstancesInstanceIdDeleteDelete /Workflow/Instances/{instanceId}Deletes the specified instance.
WorkflowInstanceApiWorkflowInstancesInstanceIdGetGet /Workflow/Instances/{instanceId}Get information relevant for knowing where an instance is in its workflow.
WorkflowInstanceApiWorkflowInstancesInstanceIdRestartPostPost /Workflow/Instances/{instanceId}/RestartRestarts a failed instance against the specified definition version or the published version if no version is specified.
WorkflowInstanceApiWorkflowInstancesInstanceIdSignalsPostPost /Workflow/Instances/{instanceId}/SignalsReceives the given signal for the given instance.
WorkflowInstanceApiWorkflowInstancesInstanceIdStopPostPost /Workflow/Instances/{instanceId}/StopRejects an instance, preventing it from continuing.
WorkflowInstanceApiWorkflowInstancesMyGetGet /Workflow/Instances/MyGets 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