Documentation
¶
Overview ¶
Copyright 2024 BeyondTrust. All rights reserved. Package entities implements DTO's used by Beyondtrust Secret Safe API.
Index ¶
- type AccountDetails
- type AssetDetails
- type AssetResponse
- type CallSecretSafeAPIObj
- type CreateFolderResponse
- type CreateManagedAccountsResponse
- type CreateSecretResponse
- type DatabaseDetails
- type DatabaseResponse
- type FolderDetails
- type FolderResponse
- type FunctionalAccountDetails
- type FunctionalAccountResponse
- type GetTokenResponse
- type ManagedAccount
- type ManagedSystemResponse
- type ManagedSystemResponseCreate
- type ManagedSystemsByAssetIdDetailsBaseConfig
- type ManagedSystemsByAssetIdDetailsConfig30
- type ManagedSystemsByAssetIdDetailsConfig31
- type ManagedSystemsByAssetIdDetailsConfig32
- type ManagedSystemsByDatabaseIdDetailsBaseConfig
- type ManagedSystemsByWorkGroupIdDetailsBaseConfig
- type ManagedSystemsByWorkGroupIdDetailsConfig30
- type ManagedSystemsByWorkGroupIdDetailsConfig31
- type ManagedSystemsByWorkGroupIdDetailsConfig32
- type ManagedSystemsByWorkGroupIdDetailsConfig33
- type OwnerDetailsGroupId
- type OwnerDetailsOwnerId
- type PlatformResponse
- type Secret
- type SecretCredentialDetailsConfig30
- type SecretCredentialDetailsConfig31
- type SecretDetailsBaseConfig
- type SecretFileDetailsConfig30
- type SecretFileDetailsConfig31
- type SecretTextDetailsConfig30
- type SecretTextDetailsConfig31
- type SignAppinResponse
- type UrlDetails
- type WorkGroupDetails
- type WorkGroupResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountDetails ¶ added in v0.8.2
type AccountDetails struct {
AccountName string `validate:"required,max=245"`
Password string `validate:"required_if=AutoManagementFlag false"`
DomainName string `validate:"max=50"`
UserPrincipalName string `validate:"omitempty,max=500"`
SAMAccountName string `validate:"omitempty,max=20"`
DistinguishedName string `validate:"omitempty,max=1000"`
PrivateKey string `validate:"omitempty"`
Passphrase string `validate:"omitempty,required_if=PrivateKey Encrypted"`
PasswordFallbackFlag bool `validate:"omitempty"`
LoginAccountFlag bool `validate:"omitempty"`
Description string `validate:"omitempty,max=1024"`
PasswordRuleID int `validate:"omitempty,gte=0"`
ApiEnabled bool `validate:"omitempty"`
ReleaseNotificationEmail string `validate:"omitempty,email,max=255"`
ChangeServicesFlag bool `validate:"omitempty"`
RestartServicesFlag bool `validate:"omitempty"`
ChangeTasksFlag bool `validate:"omitempty"`
ReleaseDuration int `validate:"omitempty,min=1,max=525600,ltefield=MaxReleaseDuration"`
MaxReleaseDuration int `validate:"omitempty,min=1,max=525600"`
ISAReleaseDuration int `validate:"omitempty,min=1,max=525600"`
MaxConcurrentRequests int `validate:"omitempty,min=0,max=999"`
AutoManagementFlag bool `validate:"omitempty"`
DSSAutoManagementFlag bool `validate:"omitempty"`
CheckPasswordFlag bool `validate:"omitempty"`
ChangePasswordAfterAnyReleaseFlag bool `validate:"omitempty"`
ResetPasswordOnMismatchFlag bool `validate:"omitempty"`
ChangeFrequencyType string `validate:"omitempty,oneof=first last xdays"`
ChangeFrequencyDays int `validate:"omitempty,min=1,max=999"`
ChangeTime string `validate:"omitempty,datetime=15:04"`
NextChangeDate string `validate:"omitempty,datetime=2006-01-02"`
UseOwnCredentials bool `validate:"omitempty"`
WorkgroupID int `json:",omitempty" validate:"omitempty"`
ChangeWindowsAutoLogonFlag bool `validate:"omitempty"`
ChangeComPlusFlag bool `validate:"omitempty"`
ChangeDComFlag bool `validate:"omitempty"`
ChangeSComFlag bool `validate:"omitempty"`
ObjectID string `validate:"omitempty,max=36"`
}
type AssetDetails ¶ added in v0.16.0
type AssetDetails struct {
IPAddress string `json:",omitempty" validate:"required,ip,max=46"`
AssetName string `json:",omitempty" validate:"omitempty,max=128"`
DnsName string `json:",omitempty" validate:"omitempty,max=255"`
DomainName string `json:",omitempty" validate:"omitempty,max=64"`
MacAddress string `json:",omitempty" validate:"omitempty,max=128"`
AssetType string `json:",omitempty" validate:"omitempty,max=64"`
Description string `json:",omitempty" validate:"omitempty,max=255"`
OperatingSystem string `json:",omitempty" validate:"omitempty,max=255"`
}
type AssetResponse ¶ added in v0.16.0
type CallSecretSafeAPIObj ¶ added in v0.15.0
type CreateFolderResponse ¶ added in v0.11.0
type CreateManagedAccountsResponse ¶ added in v0.8.2
type CreateSecretResponse ¶ added in v0.10.0
type DatabaseDetails ¶ added in v0.17.0
type DatabaseDetails struct {
PlatformID int `json:",omitempty" validate:"required"`
InstanceName string `json:",omitempty" validate:"required,max=100"`
IsDefaultInstance bool `json:",omitempty" `
Port int `json:",omitempty" validate:"required,min=1,max=65535"`
Version string `json:",omitempty" validate:"omitempty,max=20"`
Template string `json:",omitempty" validate:"omitempty"`
}
type DatabaseResponse ¶ added in v0.17.0
type FolderDetails ¶ added in v0.11.0
type FolderDetails struct {
Name string `json:",omitempty" validate:"required"`
Description string `json:",omitempty" validate:"omitempty,max=256"`
ParentId uuid.UUID `json:",omitempty" validate:"required_if=FolderType FOLDER"`
UserGroupId int `json:",omitempty" validate:"omitempty"`
FolderType string `json:",omitempty" validate:"required"`
}
type FolderResponse ¶ added in v0.10.0
type FunctionalAccountDetails ¶ added in v0.21.0
type FunctionalAccountDetails struct {
PlatformID int `validate:"required"`
DomainName string `validate:"omitempty,max=500"`
AccountName string `validate:"required,max=245"`
DisplayName string `validate:"omitempty,max=100"`
Password string `validate:"omitempty"`
PrivateKey string `validate:"omitempty"`
Passphrase string `validate:"omitempty"`
Description string `validate:"omitempty,max=1000"`
ElevationCommand string `validate:"omitempty,max=80"`
TenantID string `validate:"omitempty,max=36"`
ObjectID string `validate:"omitempty,max=36"`
Secret string `validate:"omitempty,max=255"`
ServiceAccountEmail string `validate:"omitempty,max=255"`
AzureInstance string `validate:"omitempty,oneof=AzurePublic AzureUsGovernment"`
}
type FunctionalAccountResponse ¶ added in v0.21.0
type GetTokenResponse ¶
type GetTokenResponse struct {
AccessToken string `json:"access_token"`
ExpiresIn int `json:"expires_in"`
TokenType string `json:"token_type"`
Scope string `json:"scope"`
}
GetTokenResponse responsible for token response data.
type ManagedAccount ¶
type ManagedAccount struct {
PlatformID int
SystemId int
SystemName string
DomainName string
AccountId int
AccountName string
InstanceName string
UserPrincipalName string
ApplicationID int
ApplicationDisplayName string
DefaultReleaseDuration int
MaximumReleaseDuration int
LastChangeDate string
NextChangeDate string
IsChanging bool
ChangeState int
IsISAAccess bool
PreferredNodeID string
AccountDescription string
}
ManagedAccount responsible for managed account response data.
type ManagedSystemResponse ¶ added in v0.8.2
type ManagedSystemResponseCreate ¶ added in v0.18.0
type ManagedSystemResponseCreate struct {
ManagedSystemID int `json:"ManagedSystemID"`
EntityTypeID int `json:"EntityTypeID"`
AssetID int `json:"AssetID"`
DatabaseID int `json:"DatabaseID,omitempty"`
DirectoryID int `json:"DirectoryID,omitempty"`
CloudID int `json:"CloudID,omitempty"`
WorkgroupID int `json:"WorkgroupID"`
HostName string `json:"HostName"`
DnsName string `json:"DnsName"`
IPAddress string `json:"IPAddress"`
InstanceName string `json:"InstanceName,omitempty"`
IsDefaultInstance bool `json:"IsDefaultInstance,omitempty"`
Template string `json:"Template,omitempty"`
ForestName string `json:"ForestName,omitempty"`
UseSSL bool `json:"UseSSL,omitempty"`
OracleInternetDirectoryID string `json:"OracleInternetDirectoryID,omitempty"`
OracleInternetDirectoryServiceName string `json:"OracleInternetDirectoryServiceName,omitempty"`
SystemName string `json:"SystemName"`
PlatformID int `json:"PlatformID"`
NetBiosName string `json:"NetBiosName,omitempty"`
Port int `json:"Port,omitempty"`
Timeout int `json:"Timeout"`
Description string `json:"Description"`
ContactEmail string `json:"ContactEmail"`
PasswordRuleID int `json:"PasswordRuleID"`
DSSKeyRuleID int `json:"DSSKeyRuleID"`
ReleaseDuration int `json:"ReleaseDuration"`
MaxReleaseDuration int `json:"MaxReleaseDuration"`
ISAReleaseDuration int `json:"ISAReleaseDuration"`
AutoManagementFlag bool `json:"AutoManagementFlag"`
FunctionalAccountID int `json:"FunctionalAccountID,omitempty"`
LoginAccountID int `json:"LoginAccountID,omitempty"`
ElevationCommand string `json:"ElevationCommand,omitempty"`
SshKeyEnforcementMode int `json:"SshKeyEnforcementMode"`
CheckPasswordFlag bool `json:"CheckPasswordFlag"`
ChangePasswordAfterAnyReleaseFlag bool `json:"ChangePasswordAfterAnyReleaseFlag"`
ResetPasswordOnMismatchFlag bool `json:"ResetPasswordOnMismatchFlag"`
ChangeFrequencyType string `json:"ChangeFrequencyType"`
ChangeFrequencyDays int `json:"ChangeFrequencyDays"`
ChangeTime string `json:"ChangeTime"`
AccountNameFormat int `json:"AccountNameFormat"`
RemoteClientType string `json:"RemoteClientType"`
ApplicationHostID int `json:"ApplicationHostID,omitempty"`
IsApplicationHost bool `json:"IsApplicationHost"`
AccessURL string `json:"AccessURL,omitempty"`
}
type ManagedSystemsByAssetIdDetailsBaseConfig ¶ added in v0.18.0
type ManagedSystemsByAssetIdDetailsBaseConfig struct {
PlatformID int `json:"PlatformID" validate:"required"`
ContactEmail string `json:"ContactEmail" validate:"max=1000"`
Description string `json:"Description" validate:"max=255"`
Port int `json:"Port,omitempty"`
Timeout int `json:"Timeout,omitempty"`
SshKeyEnforcementMode int `json:"SshKeyEnforcementMode,omitempty" validate:"oneof=0 1 2"`
PasswordRuleID int `json:"PasswordRuleID,omitempty"`
DSSKeyRuleID int `json:"DSSKeyRuleID,omitempty"`
LoginAccountID int `json:"LoginAccountID,omitempty"`
ReleaseDuration int `json:"ReleaseDuration" validate:"min=1,max=525600"`
MaxReleaseDuration int `json:"MaxReleaseDuration" validate:"min=1,max=525600"`
ISAReleaseDuration int `json:"ISAReleaseDuration" validate:"min=1,max=525600"`
AutoManagementFlag bool `json:"AutoManagementFlag,omitempty"`
FunctionalAccountID int `json:"FunctionalAccountID" validate:"required_if=AutoManagementFlag true"`
ElevationCommand string `json:"ElevationCommand,omitempty"`
CheckPasswordFlag bool `json:"CheckPasswordFlag,omitempty"`
ChangePasswordAfterAnyReleaseFlag bool `json:"ChangePasswordAfterAnyReleaseFlag,omitempty"`
ResetPasswordOnMismatchFlag bool `json:"ResetPasswordOnMismatchFlag,omitempty"`
ChangeFrequencyType string `json:"ChangeFrequencyType" validate:"oneof=first last xdays"`
ChangeFrequencyDays int `json:"ChangeFrequencyDays,omitempty" validate:"required_if=ChangeFrequencyType xdays"`
ChangeTime string `json:"ChangeTime" validate:"datetime=15:04"`
}
type ManagedSystemsByAssetIdDetailsConfig30 ¶ added in v0.19.0
type ManagedSystemsByAssetIdDetailsConfig30 struct {
ManagedSystemsByAssetIdDetailsBaseConfig
}
type ManagedSystemsByAssetIdDetailsConfig31 ¶ added in v0.19.0
type ManagedSystemsByAssetIdDetailsConfig31 struct {
ManagedSystemsByAssetIdDetailsBaseConfig
RemoteClientType string `json:"RemoteClientType" validate:"oneof=None EPM"`
}
type ManagedSystemsByAssetIdDetailsConfig32 ¶ added in v0.19.0
type ManagedSystemsByAssetIdDetailsConfig32 struct {
ManagedSystemsByAssetIdDetailsBaseConfig
RemoteClientType string `json:"RemoteClientType" validate:"oneof=None EPM"`
ApplicationHostID int `json:"ApplicationHostID,omitempty"`
IsApplicationHost bool `json:"IsApplicationHost"`
}
type ManagedSystemsByDatabaseIdDetailsBaseConfig ¶ added in v0.20.0
type ManagedSystemsByDatabaseIdDetailsBaseConfig struct {
ContactEmail string `json:",omitempty" validate:"max=1000"`
Description string `json:",omitempty" validate:"max=255"`
Timeout int `json:",omitempty" validate:"min=1"`
PasswordRuleID int `json:",omitempty"`
ReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
MaxReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
ISAReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
AutoManagementFlag bool `json:",omitempty"`
FunctionalAccountID int `json:",omitempty" validate:"required_if=AutoManagementFlag true"`
CheckPasswordFlag bool `json:",omitempty"`
ChangePasswordAfterAnyReleaseFlag bool `json:",omitempty"`
ResetPasswordOnMismatchFlag bool `json:",omitempty"`
ChangeFrequencyType string `json:",omitempty" validate:"oneof=first last xdays"`
ChangeFrequencyDays int `json:",omitempty" validate:"required_if=ChangeFrequencyType xdays"`
ChangeTime string `json:",omitempty" validate:"datetime=15:04"`
}
type ManagedSystemsByWorkGroupIdDetailsBaseConfig ¶ added in v0.19.0
type ManagedSystemsByWorkGroupIdDetailsBaseConfig struct {
EntityTypeID int `json:",omitempty" validate:"required"`
HostName string `json:",omitempty" validate:"required,max=128"`
IPAddress string `json:",omitempty" validate:"required,ip,max=46"`
DnsName string `json:",omitempty" validate:"max=225"`
InstanceName string `json:",omitempty" validate:"required_if=IsDefaultInstance true,max=100"`
IsDefaultInstance bool `json:",omitempty"`
Template string `json:",omitempty"`
ForestName string `json:",omitempty" validate:"max=64"`
UseSSL bool `json:",omitempty"`
PlatformID int `json:",omitempty" validate:"required"`
NetBiosName string `json:",omitempty" validate:"max=15"`
ContactEmail string `json:",omitempty" validate:"max=1000"`
Description string `json:",omitempty" validate:"max=255"`
Port int `json:",omitempty"`
Timeout int `json:",omitempty"`
SshKeyEnforcementMode int `json:",omitempty" validate:"oneof=0 1 2"`
PasswordRuleID int `json:",omitempty"`
DSSKeyRuleID int `json:",omitempty"`
LoginAccountID int `json:",omitempty"`
AccountNameFormat int `json:",omitempty" validate:"oneof=0 1 2"`
OracleInternetDirectoryID string `json:",omitempty"`
OracleInternetDirectoryServiceName string `json:",omitempty" validate:"max=200"`
ReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
MaxReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
ISAReleaseDuration int `json:",omitempty" validate:"min=1,max=525600"`
AutoManagementFlag bool `json:",omitempty"`
FunctionalAccountID int `json:",omitempty" validate:"required_if=AutoManagementFlag true"`
ElevationCommand string `json:",omitempty"`
CheckPasswordFlag bool `json:",omitempty"`
ChangePasswordAfterAnyReleaseFlag bool `json:",omitempty"`
ResetPasswordOnMismatchFlag bool `json:",omitempty"`
ChangeFrequencyType string `json:",omitempty" validate:"oneof=first last xdays"`
ChangeFrequencyDays int `json:",omitempty" validate:"required_if=ChangeFrequencyType xdays"`
ChangeTime string `json:",omitempty" validate:"datetime=15:04"`
AccessURL string `json:",omitempty"`
}
type ManagedSystemsByWorkGroupIdDetailsConfig30 ¶ added in v0.19.0
type ManagedSystemsByWorkGroupIdDetailsConfig30 struct {
ManagedSystemsByWorkGroupIdDetailsBaseConfig
}
type ManagedSystemsByWorkGroupIdDetailsConfig31 ¶ added in v0.19.0
type ManagedSystemsByWorkGroupIdDetailsConfig31 struct {
ManagedSystemsByWorkGroupIdDetailsBaseConfig
RemoteClientType string `json:"RemoteClientType" validate:"oneof=None EPM"`
}
type ManagedSystemsByWorkGroupIdDetailsConfig32 ¶ added in v0.19.0
type ManagedSystemsByWorkGroupIdDetailsConfig32 struct {
ManagedSystemsByWorkGroupIdDetailsBaseConfig
RemoteClientType string `json:"RemoteClientType" validate:"oneof=None EPM"`
ApplicationHostID int `json:"ApplicationHostID,omitempty"`
IsApplicationHost bool `json:"IsApplicationHost"`
}
type ManagedSystemsByWorkGroupIdDetailsConfig33 ¶ added in v0.19.0
type ManagedSystemsByWorkGroupIdDetailsConfig33 struct {
ManagedSystemsByWorkGroupIdDetailsBaseConfig
RemoteClientType string `json:"RemoteClientType" validate:"oneof=None EPM"`
ApplicationHostID int `json:"ApplicationHostID,omitempty"`
IsApplicationHost bool `json:"IsApplicationHost"`
}
type OwnerDetailsGroupId ¶ added in v0.22.0
type OwnerDetailsOwnerId ¶ added in v0.22.0
type PlatformResponse ¶ added in v0.21.0
type PlatformResponse struct {
PlatformID int
Name string
ShortName string
PortFlag bool
DefaultPort int
SupportsElevationFlag bool
DomainNameFlag bool
AutoManagementFlag bool
DSSAutoManagementFlag bool
ManageableFlag bool
DSSFlag bool
LoginAccountFlag bool
DefaultSessionType string
ApplicationHostFlag bool
RequiresApplicationHost bool
RequiresTenantID bool
RequiresObjectID bool
RequiresSecret bool
}
type SecretCredentialDetailsConfig30 ¶ added in v0.22.0
type SecretCredentialDetailsConfig30 struct {
SecretDetailsBaseConfig
Username string `json:",omitempty" validate:"required"`
Password string `json:",omitempty" validate:"max=256,required_without=PasswordRuleID"`
OwnerId int `json:",omitempty" validate:"required_if=OwnerType Group"`
OwnerType string `json:",omitempty" validate:"required,oneof=User Group"`
Owners []OwnerDetailsOwnerId `json:",omitempty" validate:"required_if=OwnerType User"`
PasswordRuleID int `json:",omitempty" validate:"omitempty"`
}
type SecretCredentialDetailsConfig31 ¶ added in v0.22.0
type SecretCredentialDetailsConfig31 struct {
SecretDetailsBaseConfig
Username string `json:",omitempty" validate:"required"`
Password string `json:",omitempty" validate:"max=256,required_without=PasswordRuleID"`
Owners []OwnerDetailsGroupId `json:",omitempty" validate:"required"`
PasswordRuleID int `json:",omitempty" validate:"omitempty"`
}
type SecretDetailsBaseConfig ¶ added in v0.22.0
type SecretDetailsBaseConfig struct {
Title string `json:",omitempty" validate:"required,max=256"`
Description string `json:",omitempty" validate:"omitempty,max=256"`
Notes string `json:",omitempty" validate:"omitempty,max=4000"`
Urls []UrlDetails `json:",omitempty" validate:"omitempty"`
}
type SecretFileDetailsConfig30 ¶ added in v0.22.0
type SecretFileDetailsConfig30 struct {
SecretDetailsBaseConfig
OwnerId int `json:",omitempty" validate:"required_if=OwnerType Group"`
OwnerType string `json:",omitempty" validate:"oneof=User Group"`
Owners []OwnerDetailsOwnerId `json:",omitempty" validate:"required_if=OwnerType User"`
FileName string `json:",omitempty" validate:"required,max=256"`
FileContent string `json:",omitempty" validate:"required,max=5000000"`
}
type SecretFileDetailsConfig31 ¶ added in v0.22.0
type SecretFileDetailsConfig31 struct {
SecretDetailsBaseConfig
Owners []OwnerDetailsGroupId `json:",omitempty" validate:"required"`
FileName string `json:",omitempty" validate:"required,max=256"`
FileContent string `json:",omitempty" validate:"required,max=5000000"`
}
type SecretTextDetailsConfig30 ¶ added in v0.22.0
type SecretTextDetailsConfig30 struct {
SecretDetailsBaseConfig
Text string `json:",omitempty" validate:"required,max=4096"`
OwnerId int `json:",omitempty" validate:"required_if=OwnerType Group"`
OwnerType string `json:",omitempty" validate:"oneof=User Group"`
Owners []OwnerDetailsOwnerId `json:",omitempty" validate:"required_if=OwnerType User"`
FolderId uuid.UUID `json:",omitempty" validate:"omitempty"`
}
type SecretTextDetailsConfig31 ¶ added in v0.22.0
type SecretTextDetailsConfig31 struct {
SecretDetailsBaseConfig
Text string `json:",omitempty" validate:"required,max=4096"`
Owners []OwnerDetailsGroupId `json:",omitempty" validate:"required"`
FolderId uuid.UUID `json:",omitempty" validate:"omitempty"`
}
type SignAppinResponse ¶ added in v0.16.0
type SignAppinResponse struct {
UserId int `json:"UserId"`
EmailAddress string `json:"EmailAddress"`
UserName string `json:"UserName"`
Name string `json:"Name"`
}
SignAppinResponse responsbile for API sign in information.
type UrlDetails ¶ added in v0.10.0
type WorkGroupDetails ¶ added in v0.15.0
type WorkGroupResponse ¶ added in v0.15.0
Click to show internal directories.
Click to hide internal directories.