api

package

Go to main page

Versions in this module

v3

v3.4.0

Jan 28, 2026

Changes in this version

+ func DecryptPKCS8PrivateKey(encryptedKey []byte, password string) (string, error)

+ func EncodePrivateKey(key interface{}) (*pem.Block, error)

+ func GetCertificateThumbprint(cert *x509.Certificate) (string, error)

+ func UnpackPEM(pemData interface{}, password string) (privateKey, certificate string, caCertificates []string, err error)

+ func UnpackPkcs12(pfxData interface{}, password string) (privateKey, certificate string, caCertificates []string, err error)

type Client

+ func (c *Client) CreateLocalPAMEntry(providerId int, entry *LocalPAMEntryCreateRequest) (*LocalPAMEntryResponse, error)

+ func (c *Client) CreatePAMProvider(provider *ProviderCreateRequest) (*ProviderResponseLegacy, error)

+ func (c *Client) CreatePAMProviderType(providerType *ProviderTypeCreateRequest) (*ProviderTypeResponse, error)

+ func (c *Client) DeleteLocalPAMEntry(providerId int, secretName string) error

+ func (c *Client) DeletePAMProvider(id int) error

+ func (c *Client) DeletePAMProviderType(id string) error

+ func (c *Client) GetPAMProvider(id int) (*ProviderResponseLegacy, error)

+ func (c *Client) GetPAMProviderType(id string) (*ProviderTypeResponse, error)

+ func (c *Client) GetPAMProviderTypeByName(name string) (*ProviderTypeResponse, error)

+ func (c *Client) GetPamProviderByName(name string) (*ProviderResponseLegacy, error)

+ func (c *Client) ListLocalPAMEntries(providerId int, query *GetPAMProviderQuery) (*[]LocalPAMEntryResponse, error)

+ func (c *Client) ListPAMProviderTypes() (*[]ProviderTypeResponse, error)

+ func (c *Client) ListPAMProviders(query *GetPAMProviderQuery) (*[]ProviderResponseLegacy, error)

+ func (c *Client) UpdateLocalPAMEntry(providerId int, secretName string, entry *LocalPAMEntryUpdateRequest) (*LocalPAMEntryResponse, error)

+ func (c *Client) UpdatePAMProvider(provider *ProviderUpdateRequestLegacy) (*ProviderResponseLegacy, error)

+ type GetPAMProviderQuery struct

+ PageReturned int

+ QueryString string

+ ReturnLimit int

+ SortAscending int

+ SortField string

+ type KeyfactorAPISecret struct

+ Parameters map[string]*string

+ Provider *int

+ SecretValue *string

+ type KeyfactorSecret struct

+ HasValue bool

+ InstanceGuid *string

+ InstanceId *int

+ IsManaged bool

+ ProviderId *int

+ ProviderTypeParameterValues *[]PamProviderTypeParamValue

+ RemoteProviderName *string

+ SecretType SecretType

+ SecretTypeGuid string

+ Value interface{}

+ type LocalPAMEntryCreateRequest struct

+ Description *string

+ SecretName string

+ SecretValue string

+ type LocalPAMEntryResponse struct

+ Description *string

+ ProviderId int

+ SecretName *string

+ type LocalPAMEntryUpdateRequest struct

+ Description *string

+ SecretName string

+ SecretValue *string

+ type PamParameterDataType int

+ const PamParameterDataTypeSecret

+ const PamParameterDataTypeString

+ type PamProviderTypeParam struct

+ DataType PamParameterDataType

+ DisplayName *string

+ Id int

+ InstanceLevel bool

+ Name string

+ ProviderType *ProviderType

+ type PamProviderTypeParamValue struct

+ Id int

+ InstanceGuid *string

+ InstanceId *int

+ ParameterId int

+ Provider *Provider

+ ProviderTypeParam *PamProviderTypeParam

+ Value *string

+ type PamProviderTypeParamValueResponse struct

+ Id int

+ InstanceGuid *string

+ InstanceId *int

+ ProviderTypeParam *ProviderTypeParameterResponse

+ Value *string

+ type Provider struct

+ Area int

+ Id int

+ IsInUse bool

+ IsLocalDB bool

+ Name string

+ ProviderType ProviderType

+ ProviderTypeParamValues *[]PamProviderTypeParamValue

+ Remote bool

+ SecuredAreaId *int

+ type ProviderCreateRequest struct

+ Area int

+ Name string

+ ProviderType ProviderType

+ ProviderTypeParamValues *[]PamProviderTypeParamValue

+ Remote bool

+ SecuredAreaId *int

+ type ProviderCreateRequestProviderType struct

+ Id string

+ type ProviderCreateRequestProviderTypeParam struct

+ DisplayName *string

+ Id int

+ InstanceLevel bool

+ Name string

+ type ProviderCreateRequestTypeParamValue struct

+ Id int

+ InstanceGuid *string

+ InstanceId *int

+ ProviderTypeParam *ProviderCreateRequestProviderTypeParam

+ Value *string

+ type ProviderResponseLegacy struct

+ Area int

+ Id int

+ Name *string

+ ProviderType *ProviderType

+ ProviderTypeParamValues *[]PamProviderTypeParamValueResponse

+ Remote bool

+ SecuredAreaId *int

type ProviderType

+ ProviderTypeParams *[]PamProviderTypeParam

+ type ProviderTypeCreateRequest struct

+ Name string

+ Parameters *[]ProviderTypeParameterCreateRequest

+ type ProviderTypeParameterCreateRequest struct

+ DataType PamParameterDataType

+ DisplayName *string

+ InstanceLevel bool

+ Name string

+ type ProviderTypeParameterResponse struct

+ DataType PamParameterDataType

+ DisplayName *string

+ Id int

+ InstanceLevel bool

+ Name string

+ type ProviderTypeResponse struct

+ Id string

+ Name string

+ Parameters *[]ProviderTypeParameterResponse

+ type ProviderUpdateRequestLegacy struct

+ Area int

+ Id int

+ Name string

+ ProviderType ProviderType

+ ProviderTypeParamValues *[]PamProviderTypeParamValue

+ Remote bool

+ SecuredAreaId *int

+ type SecretType int

type StorePasswordConfig

+ ProviderTypeParameterValues *[]ProviderTypeParameterValue

+ RemoteProviderName *string

+ TypedValue *string

v3.4.0-rc.5

Jan 28, 2026

v3.4.0-rc.4

Jan 9, 2026

v3.4.0-rc.3

Dec 15, 2025

v3.4.0-rc.2

Dec 5, 2025

v3.4.0-rc.1

Dec 4, 2025

v3.4.0-rc.0

Dec 4, 2025

v3.3.0

Oct 1, 2025

Changes in this version

+ type AlgorithmDataRequestV2 struct

+ CurveName *string

+ KeySize *int

+ KeyType *string

+ type AlgorithmDataResponse struct

+ BitLengths []int

+ Curves []string

+ Name string

+ type CertificateOwnerChangeParams struct

+ CollectionId *int

+ ContainerId *int

type Client

+ func (c *Client) ChangeCertificateOwnerRole(certificateId int, req *OwnerRequest, params ...*CertificateOwnerChangeParams) error

+ func (c *Client) CreateEnrollmentPattern(req *EnrollmentPatternCreateRequest, forceTemplateDefault ...bool) (*EnrollmentPatternResponse, error)

+ func (c *Client) DeleteEnrollmentPattern(id int) error

+ func (c *Client) GetEnrollmentPattern(id int) (*EnrollmentPatternResponse, error)

+ func (c *Client) GetEnrollmentPatterns(params ...*EnrollmentPatternsQueryParams) ([]EnrollmentPatternResponse, error)

+ func (c *Client) UpdateEnrollmentPattern(id int, req *EnrollmentPatternRequest, forceTemplateDefault ...bool) (*EnrollmentPatternResponse, error)

type EnrollCSRFctArgs

+ AdditionalEnrollmentFields map[string]interface{}

+ EnrollmentPatternId int

+ IncludeSubjectHeader bool

+ OwnerRoleId int

+ OwnerRoleName string

+ PrivateKey string

+ RenewalCertificateId int

type EnrollPFXFctArgsV2

+ AdditionalEnrollmentFields *map[string]interface{}

+ AlternativeKeyLength int

+ AlternativeKeyType string

+ Curve string

+ EnrollmentPatternId int

+ IncludeSubjectHeader bool

+ OwnerRoleId int

+ OwnerRoleName string

+ type EnrollmentPatternAssociatedRoleResponse struct

+ Id int

+ Name string

+ type EnrollmentPatternCAResponse struct

+ ConfigurationTenant string

+ HostName string

+ Id int

+ LogicalName string

+ type EnrollmentPatternCreateRequest struct

+ AllowedEnrollmentTypes int

+ AssociatedRoles []string

+ CertificateAuthorities []int

+ Defaults []EnrollmentPatternDefaultRequest

+ Description *string

+ EnrollmentFields []EnrollmentPatternFieldRequest

+ MetadataFields []EnrollmentPatternMetadataFieldRequest

+ Name string

+ Policies EnrollmentPatternPolicyRequest

+ Regexes []EnrollmentPatternRegexesRequest

+ RestrictCAs bool

+ Template int

+ TemplateDefault bool

+ UseADPermissions bool

+ type EnrollmentPatternDefaultRequest struct

+ DefaultValue string

+ SubjectPart string

+ type EnrollmentPatternDefaultResponse struct

+ SubjectPart string

+ Value string

+ type EnrollmentPatternFieldRequest struct

+ DefaultValue string

+ DependsOn string

+ DependsOnValue string

+ Enrollment int

+ Id int

+ Message string

+ Options string

+ Validation string

+ type EnrollmentPatternFieldResponse struct

+ DataType int

+ DefaultValue string

+ DependsOn string

+ DependsOnValue string

+ Enrollment int

+ Hint string

+ Id int

+ Message string

+ Name string

+ Options []string

+ Validation string

+ type EnrollmentPatternMetadataFieldRequest struct

+ DefaultValue string

+ DependsOn string

+ DependsOnValue string

+ Enrollment int

+ Id int

+ Message string

+ Options string

+ Validation string

+ type EnrollmentPatternMetadataFieldResponse struct

+ CaseSensitive bool

+ DefaultValue string

+ Enrollment int

+ Message string

+ MetadataId int

+ Validation string

+ type EnrollmentPatternPolicyRequest struct

+ AllowKeyReuse *bool

+ AllowWildcards *bool

+ AlternativeKeyAlgorithms []AlgorithmDataRequestV2

+ CertificateOwnerRole *int

+ DefaultCertificateOwnerOverride bool

+ DefaultCertificateOwnerRoleId *int

+ DefaultCertificateOwnerRoleName *string

+ PrimaryKeyAlgorithms []AlgorithmDataRequestV2

+ RFCEnforcement *bool

+ type EnrollmentPatternPolicyResponse struct

+ AllowKeyReuse bool

+ AllowWildcards bool

+ AlternativeKeyAlgorithms []AlgorithmDataResponse

+ CertificateOwnerRole int

+ DefaultCertificateOwnerOverride bool

+ DefaultCertificateOwnerRoleId int

+ DefaultCertificateOwnerRoleName string

+ PrimaryKeyAlgorithms []AlgorithmDataResponse

+ RFCEnforcement bool

+ type EnrollmentPatternRegexesRequest struct

+ CaseSensitive bool

+ Error string

+ Regex string

+ SubjectPart string

+ type EnrollmentPatternRegexesResponse struct

+ CaseSensitive bool

+ Error string

+ Regex string

+ SubjectPart string

+ type EnrollmentPatternRequest struct

+ AllowedEnrollmentTypes int

+ AssociatedRoles []string

+ CertificateAuthorities []int

+ Defaults []EnrollmentPatternDefaultRequest

+ Description string

+ EnrollmentFields []EnrollmentPatternFieldRequest

+ MetadataFields []EnrollmentPatternMetadataFieldRequest

+ Name string

+ Policies EnrollmentPatternPolicyRequest

+ Regexes []EnrollmentPatternRegexesRequest

+ RestrictCAs bool

+ TemplateDefault bool

+ UseADPermissions bool

+ type EnrollmentPatternResponse struct

+ AllowedEnrollmentTypes *int

+ AssociatedRoles []EnrollmentPatternAssociatedRoleResponse

+ CertificateAuthorities []EnrollmentPatternCAResponse

+ Defaults []EnrollmentPatternDefaultResponse

+ Description string

+ EnrollmentFields []EnrollmentPatternFieldResponse

+ ID int

+ MetadataFields []EnrollmentPatternMetadataFieldResponse

+ Name string

+ Policies *EnrollmentPatternPolicyResponse

+ Regexes []EnrollmentPatternRegexesResponse

+ RestrictCAs bool

+ Template *EnrollmentPatternTemplateResponse

+ TemplateDefault bool

+ UseADPermissions bool

+ type EnrollmentPatternTemplateResponse struct

+ CommonName string

+ ConfigurationTenant string

+ FriendlyName string

+ Id int

+ RequiresApproval bool

+ TemplateName string

+ type EnrollmentPatternsQueryParams struct

+ PageReturned int

+ QueryString string

+ ReturnLimit int

+ SortAscending *int

+ SortField string

type GetCertificateResponse

+ AltKeyAlgorithm string

+ AltKeySizeInBits int

+ AltKeyType int

+ AltKeyTypeString string

+ AltSigningAlgorithm string

+ CARecordId string

+ Curve string

+ EnrollmentPatternId int

+ HasAltPrivateKey bool

+ IssuedEmail string

+ KeyAlgorithm string

+ OwnerRoleId int

+ OwnerRoleName string

+ type OwnerRequest struct

+ NewRoleId *int

+ NewRoleName *string

v3.3.0-rc.6

Oct 1, 2025

v3.3.0-rc.5

Sep 28, 2025

v3.3.0-rc.4

Sep 25, 2025

v3.3.0-rc.3

Sep 24, 2025

v3.3.0-rc.2

Sep 24, 2025

v3.3.0-rc.0

Sep 23, 2025

v3.2.0

Sep 21, 2025

Changes in this version

+ type ProviderTypeParam struct

+ DataType int

+ DisplayName *string

+ Id int

+ InstanceLevel bool

+ Name *string

+ ProviderType *string

+ type ProviderTypeParameterValue struct

+ Id int

+ InstanceGuid *string

+ InstanceId *string

+ ParameterId int

+ Provider *string

+ ProviderTypeParam ProviderTypeParam

+ Value *string

type StorePasswordConfig

+ HasValue bool

+ InstanceGuid *string

+ IsManaged bool

+ ProviderId int

+ ProvidererTypeParameterValues *[]ProviderTypeParameterValue

+ type UpdateStorePasswordConfig struct

+ Parameters map[string]string

+ Provider int

+ SecretValue *string

v3.2.0-rc.5

Jul 24, 2025

v3.2.0-rc.4

Jul 24, 2025

v3.2.0-rc.3

Jul 24, 2025

v3.2.0-rc.2

Jul 24, 2025

v3.2.0-rc.1

Mar 3, 2025

v3.1.0

Jan 17, 2025

v3.1.0-rc.7

Feb 4, 2026

v3.1.0-rc.6

Oct 1, 2025

v3.1.0-rc.5

Sep 21, 2025

v3.1.0-rc.4

Sep 21, 2025

v3.1.0-rc.3

Jan 17, 2025

v3.1.0-rc.2

Jan 16, 2025

v3.1.0-rc.1

Jan 16, 2025

v3.1.0-rc.0

Jan 16, 2025

v3.0.0

Nov 20, 2024

Changes in this version

+ const MAX_CONTEXT_DEADLINE_RETRIES

+ const MAX_ITERATIONS

+ const MAX_WAIT_SECONDS

+ var DefaultAPIPath = auth_providers.DefaultCommandAPIPath

+ var EnvCommandAPI = auth_providers.EnvKeyfactorAPIPath

+ var EnvCommandClientId = auth_providers.EnvKeyfactorClientID

+ var EnvCommandClientSecret = auth_providers.EnvKeyfactorClientSecret

+ var EnvCommandDomain = auth_providers.EnvKeyfactorDomain

+ var EnvCommandHostname = auth_providers.EnvKeyfactorHostName

+ var EnvCommandOAuthTokenUrl = auth_providers.EnvKeyfactorAuthTokenURL

+ var EnvCommandPassword = auth_providers.EnvKeyfactorPassword

+ var EnvCommandTimeout = auth_providers.EnvKeyfactorClientTimeout

+ var EnvCommandUsername = auth_providers.EnvKeyfactorUsername

+ func ConvertBase64P7BtoCertificates(base64P7B string) ([]*x509.Certificate, error)

+ func ConvertBase64P7BtoPEM(base64P7B string) ([]string, error)

+ type AddCertificateToStore struct

+ CertificateId int

+ CertificateStores *[]CertificateStore

+ CollectionId int

+ InventorySchedule *InventorySchedule

+ type Agent struct

+ AgentId string

+ AgentPlatform int

+ AuthCertificateReenrollment string

+ Blueprint string

+ Capabilities []string

+ ClientMachine string

+ LastErrorCode int

+ LastErrorMessage string

+ LastSeen string

+ LastThumbprintUsed string

+ LegacyThumbprint string

+ Status int

+ Thumbprint string

+ Username string

+ Version string

+ type Agent9x struct

+ AgentId string

+ AgentPlatform int

+ AgentPoolId string

+ ClientMachine string

+ EnableDiscover bool

+ EnableMonitor bool

+ LastSeen string

+ LegacyThumbprint string

+ Status int

+ Thumbprint string

+ Username string

+ Version string

+ type AuthConfig interface

+ Authenticate func() error

+ GetHttpClient func() (*http.Client, error)

+ GetServerConfig func() *auth_providers.Server

+ type CA struct

+ Agent string

+ AllowedEnrollmentTypes int

+ AllowedRequesters []string

+ Delegate bool

+ DenialMax int

+ ExplicitCredentials bool

+ ExplicitPassword struct{ ... }

+ ExplicitUser string

+ FailureMax int

+ ForestRoot string

+ HostName string

+ Id int

+ IssuanceMax int

+ IssuanceMin int

+ KeyRetention int

+ KeyRetentionDays int

+ LogicalName string

+ MonitorThresholds bool

+ Properties string

+ RFCEnforcement bool

+ Remote bool

+ Standalone bool

+ SubscriberTerms bool

+ UseAllowedRequesters bool

+ type CRLDistributionPoints struct

+ Id int

+ URL string

+ URLHash string

+ type CertStoreContainer struct

+ CertStoreType int

+ Id *int

+ Name string

+ OverwriteSchedules bool

+ Schedule string

+ type CertStoreInventory struct

+ Certificates []InventoriedCertificate

+ Ids []int

+ Name string

+ Serials []string

+ Thumbprints []string

+ type CertStoreInventoryV1 struct

+ CertStoreInventoryItemId int

+ Certificates []InventoriedCertificate

+ Ids map[int]bool

+ Name string

+ Parameters map[string]interface{}

+ Properties map[string]interface{}

+ Serials map[string]bool

+ Thumbprints map[string]bool

+ type CertStoreTypeResponse struct

+ BlueprintAllowed bool

+ Capability string

+ CustomAliasAllowed string

+ DiscoveryJobType string

+ EnrollmentJobType string

+ ImportType int

+ InventoryEndpoint string

+ InventoryJobType string

+ JobProperties []string

+ LocalStore bool

+ ManagementJobType string

+ Name string

+ PasswordOptions struct{ ... }

+ PowerShell bool

+ PrivateKeyAllowed string

+ Properties []PropertyDefinition

+ ServerRegistration int

+ ServerRequired bool

+ ShortName string

+ StorePathValue []string

+ StoreType int

+ SupportedOperations struct{ ... }

+ type CertStoreTypeResponseList []struct

+ type CertificateInformation struct

+ Certificates []string

+ DispositionMessage string

+ EnrollmentContext interface{}

+ IssuerDN string

+ KeyfactorID int

+ KeyfactorRequestID int

+ PKCS12Blob string

+ RequestDisposition string

+ SerialNumber string

+ Thumbprint string

+ type CertificateInformationV2 struct

+ DispositionMessage string

+ EnrollmentContext interface{}

+ IssuerDN string

+ KeyfactorId int

+ KeyfactorRequestId int

+ Password interface{}

+ Pkcs12Blob string

+ RequestDisposition string

+ SerialNumber string

+ StoreIdsInvalidForRenewal []interface{}

+ Thumbprint string

+ WorkflowInstanceId string

+ WorkflowReferenceId int

+ type CertificateLocations struct

+ Alias string

+ CertStoreId string

+ ChainLevel int

+ StoreMachine string

+ StorePath string

+ StoreType int

+ type CertificateStore struct

+ Alias string

+ CertificateStoreId string

+ EntryPassword *EntryPassword

+ IncludePrivateKey bool

+ JobParameters map[string]string

+ Overwrite bool

+ PfxPassword string

+ type CertificateStoreType struct

+ BlueprintAllowed bool

+ Capability string

+ CustomAliasAllowed string

+ DiscoveryJobType string

+ EnrollmentJobType string

+ EntryParameters *[]EntryParameter

+ ImportType int

+ InventoryEndpoint string

+ InventoryJobType string

+ JobProperties *[]string

+ LocalStore bool

+ ManagementJobType string

+ Name string

+ PasswordOptions *StoreTypePasswordOptions

+ PowerShell bool

+ PrivateKeyAllowed string

+ Properties *[]StoreTypePropertyDefinition

+ ServerRegistration int

+ ServerRequired bool

+ ShortName string

+ StorePathType string

+ StorePathValue string

+ StoreType int

+ SupportedOperations *StoreTypeSupportedOperations

+ type CertificateStoreTypeGeneric struct

+ BlueprintAllowed bool

+ Capability string

+ CustomAliasAllowed string

+ EntryParameters *[]EntryParameterGeneric

+ LocalStore bool

+ Name string

+ PasswordOptions *StoreTypePasswordOptions

+ PowerShell bool

+ PrivateKeyAllowed string

+ Properties *[]StoreTypePropertyDefinitionGeneric

+ ServerRequired bool

+ ShortName string

+ StorePathValue string

+ SupportedOperations *StoreTypeSupportedOperations

+ type CertificateSubject struct

+ SubjectCommonName string

+ SubjectCountry string

+ SubjectLocality string

+ SubjectOrganization string

+ SubjectOrganizationalUnit string

+ SubjectState string

+ type Client struct

+ AuthClient AuthConfig

+ LoggerType string

+ func NewKeyfactorClient(cfg *auth_providers.Server, ctx *context.Context) (*Client, error)

+ func (c *Client) AddCertificateToStores(config *AddCertificateToStore) ([]string, error)

+ func (c *Client) ApproveAgent(id string) (string, error)

+ func (c *Client) CreateSecurityIdentity(csia *CreateSecurityIdentityArg) (*CreateSecurityIdentityResponse, error)

+ func (c *Client) CreateSecurityRole(input *CreateSecurityRoleArg) (*CreateSecurityRoleResponse, error)

+ func (c *Client) CreateStore(ca *CreateStoreFctArgs) (*CreateStoreResponse, error)

+ func (c *Client) CreateStoreType(ca *CertificateStoreType) (*CertificateStoreType, error)

+ func (c *Client) DeleteCertificateStore(storeId string) error

+ func (c *Client) DeleteCertificateStoreType(id int) (*DeleteStoreType, error)

+ func (c *Client) DeleteSecurityIdentity(id int) error

+ func (c *Client) DeleteSecurityRole(id int) error

+ func (c *Client) DeployPFXCertificate(args *DeployPFXArgs) (*DeployPFXResp, error)

+ func (c *Client) DisApproveAgent(id string) (string, error)

+ func (c *Client) DownloadCertificate(certId int, thumbprint string, serialNumber string, issuerDn string) (*x509.Certificate, []*x509.Certificate, error)

+ func (c *Client) EnrollCSR(ea *EnrollCSRFctArgs) (*EnrollResponse, error)

+ func (c *Client) EnrollPFX(ea *EnrollPFXFctArgs) (*EnrollResponse, error)

+ func (c *Client) EnrollPFXV2(ea *EnrollPFXFctArgsV2) (*EnrollResponseV2, error)

+ func (c *Client) FetchAgentLogs(id string) (string, error)

+ func (c *Client) GetAgent(id string) ([]Agent, error)

+ func (c *Client) GetAgentList() ([]Agent, error)

+ func (c *Client) GetAllMetadataFields() ([]MetadataField, error)

+ func (c *Client) GetCAList() ([]CA, error)

+ func (c *Client) GetCertStoreInventory(storeId string) (*[]CertStoreInventory, error)

+ func (c *Client) GetCertificateContext(gca *GetCertificateContextArgs) (*GetCertificateResponse, error)

+ func (c *Client) GetCertificateStoreByClientAndStorePath(clientMachine string, storePath, containerID interface{}) (*[]GetCertificateStoreResponse, error)

+ func (c *Client) GetCertificateStoreByContainerID(containerID interface{}) (*[]GetCertificateStoreResponse, error)

+ func (c *Client) GetCertificateStoreByID(storeId string) (*GetCertificateStoreResponse, error)

+ func (c *Client) GetCertificateStoreType(id interface{}) (*CertificateStoreType, error)

+ func (c *Client) GetCertificateStoreTypeById(id int) (*CertificateStoreType, error)

+ func (c *Client) GetCertificateStoreTypeByName(name string) (*CertificateStoreType, error)

+ func (c *Client) GetSecurityIdentities() ([]GetSecurityIdentityResponse, error)

+ func (c *Client) GetSecurityRole(id interface{}) (*GetSecurityRoleResponse, error)

+ func (c *Client) GetSecurityRoles() ([]GetSecurityRolesResponse, error)

+ func (c *Client) GetStoreContainer(id interface{}) (*CertStoreContainer, error)

+ func (c *Client) GetStoreContainers() (*[]CertStoreContainer, error)

+ func (c *Client) GetTemplate(Id interface{}) (*GetTemplateResponse, error)

+ func (c *Client) GetTemplates() ([]GetTemplateResponse, error)

+ func (c *Client) ListCertificateStoreTypes() (*[]CertificateStoreType, error)

+ func (c *Client) ListCertificateStores(params *map[string]interface{}) (*[]GetCertificateStoreResponse, error)

+ func (c *Client) ListCertificates(q map[string]string) ([]GetCertificateResponse, error)

+ func (c *Client) ListDeniedCertificates(q map[string]string) ([]WorkflowCertificate, error)

+ func (c *Client) ListExternalValidationPendingCertificates(q map[string]string) ([]WorkflowCertificate, error)

+ func (c *Client) ListPendingCertificates(q map[string]string) ([]WorkflowCertificate, error)

+ func (c *Client) ListWorkflowCert(endpoint string) ([]WorkflowCertificate, error)

+ func (c *Client) RecoverCertificate(certId int, thumbprint string, serialNumber string, issuerDn string, ...) (interface{}, *x509.Certificate, []*x509.Certificate, error)

+ func (c *Client) RemoveCertificateFromStores(config *RemoveCertificateFromStore) ([]string, error)

+ func (c *Client) ResetAgent(id string) (string, error)

+ func (c *Client) RevokeCert(rvargs *RevokeCertArgs) error

+ func (c *Client) UpdateMetadata(um *UpdateMetadataArgs) error

+ func (c *Client) UpdateSecurityRole(input *UpdateSecurityRoleArg) (*UpdateSecurityRoleResponse, error)

+ func (c *Client) UpdateStore(ua *UpdateStoreFctArgs) (*UpdateStoreResponse, error)

+ func (c *Client) UpdateStoreType(ca *CertificateStoreType) (*CertificateStoreType, error)

+ func (c *Client) UpdateTemplate(uta *UpdateTemplateArg) (*UpdateTemplateResponse, error)

+ type CreateSecurityIdentityArg struct

+ AccountName string

+ type CreateSecurityIdentityResponse struct

+ AccountName string

+ Id int

+ IdentityType string

+ Roles []SecurityRoleInformation

+ Valid bool

+ type CreateSecurityRoleArg struct

+ Description string

+ Enabled *bool

+ Identities *[]SecurityRoleIdentityConfig

+ Name string

+ Permissions *[]string

+ Private *bool

+ type CreateSecurityRoleResponse struct

+ Description string

+ Enabled *bool

+ Id int

+ Identities *[]SecurityRoleIdentityConfig

+ Immutable bool

+ Name string

+ Permissions *[]string

+ Private *bool

+ type CreateStoreFctArgs struct

+ AgentAssigned *bool

+ AgentId string

+ Approved *bool

+ CertStoreInventoryJobId *string

+ CertStoreType int

+ ClientMachine string

+ ContainerId *int

+ ContainerName *string

+ CreateIfMissing *bool

+ InventorySchedule *InventorySchedule

+ Password *StorePasswordConfig

+ Properties map[string]interface{}

+ PropertiesString string

+ ReEnrollmentStatus *ReEnrollmnentConfig

+ SetNewPasswordAllowed *bool

+ StorePath string

+ type CreateStoreResponse struct

+ AgentAssigned bool

+ AgentId string

+ Approved bool

+ CertStoreInventoryJobId string

+ CertStoreType int

+ ClientMachine string

+ ContainerId int

+ ContainerName string

+ CreateIfMissing bool

+ Id string

+ InventorySchedule InventorySchedule

+ Properties map[string]string

+ PropertiesString string

+ ReenrollmentStatus ReEnrollmnentConfig

+ SetNewPasswordAllowed bool

+ Storepath string

+ type DeleteStoreType struct

+ ID int

+ type DeployPFXArgs struct

+ CertificateId int

+ JobTime *string

+ Password string

+ RequestId int

+ StoreIds []string

+ StoreTypes []StoreTypes

+ type DeployPFXResp struct

+ FailedStores []string

+ SuccessfulStores []string

+ type DetailedKeyUsage struct

+ CrlSign bool

+ DataEncipherment bool

+ DecipherOnly bool

+ DigitalSignature bool

+ EncipherOnly bool

+ HexCode string

+ KeyAgreement bool

+ KeyCertSign bool

+ KeyEncipherment bool

+ NonRepudiation bool

+ type EnrollCSRFctArgs struct

+ CSR string

+ CertFormat string

+ CertificateAuthority string

+ IncludeChain bool

+ Metadata map[string]interface{}

+ SANs *SANs

+ Template string

+ Timestamp string

+ type EnrollPFXFctArgs struct

+ CertFormat string

+ CertificateAuthority string

+ CustomFriendlyName string

+ IncludeChain bool

+ Metadata map[string]interface{}

+ Password string

+ PopulateMissingValuesFromAD bool

+ RenewalCertificateId int

+ SANs *SANs

+ Subject *CertificateSubject

+ SubjectString string

+ Template string

+ Timestamp string

+ type EnrollPFXFctArgsV2 struct

+ CertFormat string

+ CertificateAuthority string

+ ChainOrder string

+ CustomFriendlyName string

+ IncludeChain bool

+ InstallIntoExistingCertificateStores bool

+ KeyLength int

+ KeyType string

+ Metadata map[string]interface{}

+ Password string

+ PopulateMissingValuesFromAD bool

+ RenewalCertificateId int

+ SANs *SANs

+ Stores []CertificateStore

+ Subject *CertificateSubject

+ SubjectString string

+ Template string

+ Timestamp string

+ type EnrollResponse struct

+ CertificateInformation CertificateInformation

+ Certificates []string

+ type EnrollResponseV2 struct

+ CertificateInformation CertificateInformation

+ Metadata interface{}

+ SuccessfulStores []string

+ type EntryParameter struct

+ DefaultValue string

+ DependsOn string

+ DisplayName string

+ Name string

+ Options string

+ RequiredWhen struct{ ... }

+ StoreTypeId int

+ Type string

+ type EntryParameterGeneric struct

+ DefaultValue string

+ DependsOn string

+ DisplayName string

+ Name string

+ Options string

+ RequiredWhen struct{ ... }

+ Type string

+ type EntryPassword struct

+ Parameters struct{}

+ Provider int

+ SecretValue string

+ type GetCertStoreInventoryResp struct

+ Inventory []CertStoreInventory

+ type GetCertificateContextArgs struct

+ CollectionId *int

+ CommonName string

+ Id int

+ IncludeHasPrivateKey *bool

+ IncludeLocations *bool

+ IncludeMetadata *bool

+ RequestId int

+ Thumbprint string

+ type GetCertificateResponse struct

+ ArchivedKey bool

+ CARowIndex int

+ CRLDistributionPoints []CRLDistributionPoints

+ CertRequestId int

+ CertState int

+ CertStateString string

+ CertificateAuthorityId int

+ CertificateAuthorityName string

+ CertificateKeyId int

+ ContentBytes string

+ DetailedKeyUsage []DetailedKeyUsage

+ ExtendedKeyUsages []interface{}

+ HasPrivateKey bool

+ Id int

+ ImportDate string

+ IssuedCN string

+ IssuedDN string

+ IssuedOU string

+ IssuerDN string

+ KeyRecoverable bool

+ KeySizeInBits int

+ KeyType int

+ KeyTypeString string

+ KeyUsage int

+ Locations []CertificateLocations

+ LocationsCount []LocationsCount

+ Metadata interface{}

+ NotAfter string

+ NotBefore string

+ PrincipalId string

+ PrincipalName string

+ RequesterId int

+ RequesterName string

+ RevocationComment string

+ RevocationEffDate string

+ RevocationReason int

+ SSLLocations []SSLLocations

+ SerialNumber string

+ SigningAlgorithm string

+ SubjectAltNameElements []SubjectAltNameElements

+ TemplateId int

+ TemplateName string

+ Thumbprint string

+ type GetCertificateStoreResponse struct

+ AgentAssigned bool

+ AgentId string

+ Approved bool

+ CertStoreInventoryJobId string

+ CertStoreType int

+ ClientMachine string

+ ContainerId int

+ ContainerName string

+ CreateIfMissing bool

+ DisplayName string

+ Id string

+ InventorySchedule InventorySchedule

+ Password StorePasswordConfig

+ Properties map[string]interface{}

+ PropertiesString string

+ ReenrollmentStatus ReEnrollmnentConfig

+ SetNewPasswordAllowed bool

+ StorePath string

+ type GetSecurityIdentityResponse struct

+ AccountName string

+ Id int

+ IdentityType string

+ Roles []SecurityRoleInformation

+ Valid bool

+ type GetSecurityRoleResponse struct

+ Description string

+ Id float64

+ Identities []SecurityIdentity

+ Name string

+ Permissions []string

+ type GetSecurityRolesResponse struct

+ Description string

+ Enabled bool

+ ID float64

+ Identities []SecurityIdentity

+ Immutable bool

+ Name string

+ Permissions []string

+ Private bool

+ Valid bool

+ type GetTemplateResponse struct

+ AllowedEnrollmentTypes int

+ AllowedRequesters []string

+ CommonName string

+ EnrollmentFields []TemplateEnrollmentFields

+ ForestRoot string

+ FriendlyName string

+ Id int

+ KeyArchival bool

+ KeyRetention string

+ KeyRetentionDays int

+ KeySize string

+ KeyType string

+ KeyUsage int

+ MetadataFields []TemplateMetadataFields

+ Oid string

+ RFCEnforcement bool

+ RequiresApproval bool

+ TemplateName string

+ TemplateRegexes []TemplateRegex

+ UseAllowedRequesters bool

+ type InventoriedCertificate struct

+ CertStoreInventoryItemId int

+ Id int

+ IssuedDN string

+ IssuerDN string

+ Metadata map[string]interface{}

+ NotAfter string

+ NotBefore string

+ SerialNumber string

+ SigningAlgorithm string

+ Thumbprint string

+ type InventoryDaily struct

+ Time string

+ type InventoryInterval struct

+ Minutes int

+ type InventoryOnce struct

+ Time string

+ type InventorySchedule struct

+ Daily *InventoryDaily

+ ExactlyOnce *InventoryOnce

+ Immediate *bool

+ Interval *InventoryInterval

+ type ListCertificateResponse struct

+ Certificates []GetCertificateResponse

+ type ListCertificateStoresResponse struct

+ CertificateStores []CertificateStore

+ type LocationsCount struct

+ Count int

+ Type string

+ type MetadataField struct

+ DataType int

+ DefaultValue string

+ Description string

+ DisplayOrder int

+ Enrollment int

+ Hint string

+ Id int

+ Message string

+ Name string

+ Options string

+ Validation string

+ type PropertyDefinition struct

+ DefaultValue string

+ DependsOn string

+ DisplayName string

+ Name string

+ Required bool

+ StoreTypeID int

+ Type string

+ type ProviderParams struct

+ Area int

+ Id int

+ Name string

+ ProviderType ProviderType

+ type ProviderType struct

+ Id string

+ Name string

+ type ProviderTypeParams struct

+ Id string

+ InstanceGuid string

+ InstanceId string

+ Provider ProviderParams

+ Value string

+ type ReEnrollmnentConfig struct

+ AgentId string

+ CustomAliasAllowed int

+ Data bool

+ JobProperties string

+ Message string

+ type RemoveCertificateFromStore struct

+ Alias string

+ CertificateId int

+ CertificateStores *[]CertificateStore

+ CollectionId int

+ InventorySchedule *InventorySchedule

+ type RevokeCertArgs struct

+ CertificateIds []int

+ CollectionId int

+ Comment string

+ EffectiveDate string

+ Reason int

+ type SANs struct

+ DNS []string

+ IP4 []string

+ IP6 []string

+ URI []string

+ type SSLLocations struct

+ AgentPool string

+ IPAddress string

+ NetworkName string

+ Port int

+ StorePath string

+ type SecretParamValue struct

+ SecretValue string

+ type SecurityIdentity struct

+ AccountName string

+ Id float64

+ IdentityType string

+ Sid string

+ type SecurityRoleIdentityConfig struct

+ AccountName string

+ SID *string

+ type SecurityRoleInformation struct

+ Description string

+ Id int

+ Name string

+ type SecurityRolePermission struct

+ API *string

+ AdminPortal *string

+ AgentAutoRegistration *string

+ AgentManagement *string

+ Auditing *string

+ CertificateCollections *string

+ CertificateEnrollment *string

+ CertificateMetadataTypes *string

+ CertificateStoreManagement *string

+ Certificates *string

+ Dashboard *string

+ MacAutoEnrollManagement *string

+ Monitoring *string

+ PkiManagement *string

+ Reports *string

+ SSH *string

+ SecuritySettings *string

+ SslManagement *string

+ SystemSettings *string

+ WorkflowManagement *string

+ type SpecialPropertiesSecretValue struct

+ Value SecretParamValue

+ type SpecialPropertiesValue struct

+ Value interface{}

+ type StorePasswordConfig struct

+ InstanceId *string

+ SecretTypeGuid *string

+ Value *string

+ type StoreTypePasswordOptions struct

+ EntrySupported bool

+ StoreRequired bool

+ Style string

+ type StoreTypePropertyDefinition struct

+ DefaultValue interface{}

+ DependsOn interface{}

+ DisplayName string

+ Name string

+ Required bool

+ StoreTypeID int

+ Type string

+ type StoreTypePropertyDefinitionGeneric struct

+ DefaultValue interface{}

+ DependsOn interface{}

+ DisplayName string

+ Name string

+ Required bool

+ Type string

+ type StoreTypeSupportedOperations struct

+ Add bool

+ Create bool

+ Discovery bool

+ Enrollment bool

+ Remove bool

+ type StoreTypes struct

+ Alias *string

+ Overwrite *bool

+ Properties *[]string

+ StoreTypeId int

+ type StringTuple struct

+ Elem1 string

+ Elem2 string

+ type SubjectAltNameElements struct

+ Id int

+ Type int

+ Value string

+ ValueHash string

+ type TemplateEnrollmentFields struct

+ DataType int

+ Id int

+ Name string

+ Options []string

+ type TemplateMetadataFields struct

+ DefaultValue string

+ Enrollment int

+ Id int

+ Message string

+ MetadataId int

+ Options string

+ Validation string

+ type TemplateRegex struct

+ Error string

+ RegEx string

+ SubjectPart string

+ TemplateId int

+ type TerraformLogger struct

+ func (w *TerraformLogger) Write(p []byte) (n int, err error)

+ type UpdateMetadataArgs struct

+ CertID int

+ CertificateMetadata []StringTuple

+ CollectionId int

+ Metadata map[string]interface{}

+ type UpdateSecurityRoleArg struct

+ Id int

+ type UpdateSecurityRoleResponse struct

+ type UpdateStoreFctArgs struct

+ AgentAssigned *bool

+ AgentId string

+ Approved *bool

+ CertStoreInventoryJobId *string

+ CertStoreType int

+ ClientMachine string

+ ContainerId *int

+ ContainerName *string

+ CreateIfMissing *bool

+ Id string

+ InventorySchedule *InventorySchedule

+ Password *StorePasswordConfig

+ Properties map[string]interface{}

+ PropertiesString string

+ ReEnrollmentStatus *ReEnrollmnentConfig

+ SetNewPasswordAllowed *bool

+ StorePath string

+ type UpdateStoreResponse struct

+ type UpdateTemplateArg struct

+ AllowedEnrollmentTypes *int

+ AllowedRequesters *[]string

+ CommonName string

+ EnrollmentFields *[]TemplateEnrollmentFields

+ ForestRoot string

+ FriendlyName *string

+ Id int

+ KeyArchival *bool

+ KeyRetention *string

+ KeyRetentionDays *int

+ KeySize string

+ KeyType *string

+ KeyUsage *bool

+ MetadataFields *[]TemplateMetadataFields

+ Oid string

+ RFCEnforcement *bool

+ RequiresApproval *bool

+ TemplateName string

+ TemplateRegexes *[]TemplateRegex

+ UseAllowedRequesters *bool

+ type UpdateTemplateResponse struct

+ type WorkflowActionResponse struct

+ Denials []struct{ ... }

+ Failures []struct{ ... }

+ Successes []struct{ ... }

+ type WorkflowCertificate struct

+ CARequestId string

+ CertificateAuthority string

+ CommonName string

+ DistinguishedName string

+ Id int

+ Metadata map[string]string

+ Requester string

+ State int

+ StateString string

+ SubmissionDate time.Time

+ Template string

+ type WorkflowDenyCertificateRequest struct

+ CertificateRequestIds []int

+ Comment string

v3.0.0-rc.12

Dec 17, 2024

v3.0.0-rc.11

Nov 1, 2024

v3.0.0-rc.10

Nov 1, 2024

v3.0.0-rc.9

Nov 1, 2024

v3.0.0-rc.8

Nov 1, 2024

v3.0.0-rc.7

Oct 31, 2024

v3.0.0-rc.6

Oct 28, 2024

v3.0.0-rc.5

Oct 24, 2024

v3.0.0-rc.3

Oct 24, 2024

v3.0.0-rc.2

Oct 21, 2024

Other modules containing this package

github.com/Keyfactor/keyfactor-go-client

github.com/Keyfactor/keyfactor-go-client/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL