Documentation
¶
Index ¶
- type ArkSecHubDeleteSyncPolicy
- type ArkSecHubGetSyncPolicies
- type ArkSecHubGetSyncPolicy
- type ArkSecHubPolicy
- type ArkSecHubPolicyFilter
- type ArkSecHubPolicyState
- type ArkSecHubPolicyStateDetails
- type ArkSecHubPolicyStatus
- type ArkSecHubPolicyStore
- type ArkSecHubPolicyTransformation
- type ArkSecHubSetSyncPolicyState
- type ArkSecHubSyncPoliciesFilters
- type ArkSecHubSyncPoliciesStats
- type ArkSechubCreateSyncPolicy
- type ArkSechubSyncPolicyFilter
- type ArkSechubSyncPolicyFilterData
- type ArkSechubSyncPolicyStore
- type ArkSechubSyncPolicyTransformation
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArkSecHubDeleteSyncPolicy ¶
type ArkSecHubDeleteSyncPolicy struct {
PolicyID string `` /* 128-byte string literal not displayed */
}
ArkSecHubDeleteSyncPolicy contains the policy id for the policy to delete
type ArkSecHubGetSyncPolicies ¶
type ArkSecHubGetSyncPolicies struct {
Projection string `` /* 176-byte string literal not displayed */
}
ArkSecHubGetSyncPolicies contains the query option for retrieving sync policies.
type ArkSecHubGetSyncPolicy ¶
type ArkSecHubGetSyncPolicy struct {
PolicyID string `` /* 128-byte string literal not displayed */
Projection string `` /* 156-byte string literal not displayed */
}
ArkSecHubGetSyncPolicy contains the policy id for the policy to retrieve
type ArkSecHubPolicy ¶
type ArkSecHubPolicy struct {
ID string `json:"id" mapstructure:"id" desc:"Unique identifier of the policy"`
Name string `json:"name" mapstructure:"name" desc:"Name of the policy"`
Description string `json:"description,omitempty" mapstructure:"description,omitempty" desc:"Description of the policy"`
CreatedAt string `json:"created_at" mapstructure:"created_at" desc:"Timestamp when the policy was created"`
UpdatedAt string `json:"updated_at" mapstructure:"updated_at" desc:"Timestamp when the policy was last updated"`
CreatedBy string `json:"created_by" mapstructure:"created_by" desc:"User who created the policy"`
UpdatedBy string `json:"updated_by" mapstructure:"updated_by" desc:"User who last updated the policy"`
Source ArkSecHubPolicyStore `json:"source" mapstructure:"source" desc:"Source store reference"`
Target ArkSecHubPolicyStore `json:"target" mapstructure:"target" desc:"Target store reference"`
Filter ArkSecHubPolicyFilter `json:"filter" mapstructure:"filter" desc:"Filter reference"`
Transformation ArkSecHubPolicyTransformation `json:"transformation,omitzero" mapstructure:"transformation,omitempty" desc:"Transformation reference"`
State ArkSecHubPolicyState `json:"state" mapstructure:"state" desc:"Current state of the policy"`
Status ArkSecHubPolicyStatus `json:"status,omitzero" mapstructure:"status,omitempty" desc:"Status of the policy"`
}
ArkSecHubPolicy represents a synchronization policy with detailed source, target, filter, status, and state.
type ArkSecHubPolicyFilter ¶
type ArkSecHubPolicyFilter struct {
ID string `json:"id" mapstructure:"id" desc:"Unique identifier of the filter"`
Type string `json:"type,omitempty" mapstructure:"type,omitempty" desc:"Type of the filter"`
Data map[string]interface{} `json:"data,omitempty" mapstructure:"data,omitempty" desc:"Filter-specific data"`
CreatedAt string `json:"created_at,omitempty" mapstructure:"created_at,omitempty" desc:"Timestamp when the filter was created"`
UpdatedAt string `json:"updated_at,omitempty" mapstructure:"updated_at,omitempty" desc:"Timestamp when the filter was last updated"`
CreatedBy string `json:"created_by,omitempty" mapstructure:"created_by,omitempty" desc:"User who created the filter"`
UpdatedBy string `json:"updated_by,omitempty" mapstructure:"updated_by,omitempty" desc:"User who last updated the filter"`
}
ArkSecHubPolicyFilter represents a reference to a filter with details.
type ArkSecHubPolicyState ¶
type ArkSecHubPolicyState struct {
Current string `json:"current" mapstructure:"current" desc:"Current state value (e.g., ENABLED)"`
StateDetails *ArkSecHubPolicyStateDetails `json:"state_details,omitempty" mapstructure:"state_details,omitempty" desc:"Details about the state transition"`
}
ArkSecHubPolicyState represents the current state of the policy.
type ArkSecHubPolicyStateDetails ¶
type ArkSecHubPolicyStateDetails struct {
Status string `json:"status,omitempty" mapstructure:"status,omitempty" desc:"Status of the state transition"`
FromState string `json:"from_state,omitempty" mapstructure:"from_state,omitempty" desc:"Previous state"`
ToState string `json:"to_state,omitempty" mapstructure:"to_state,omitempty" desc:"New state"`
}
ArkSecHubPolicyStateDetails provides details about the state transition.
type ArkSecHubPolicyStatus ¶
type ArkSecHubPolicyStatus struct {
PolicyID string `json:"policy_id,omitempty" mapstructure:"policy_id,omitempty" desc:"ID of the policy"`
PolicyStatus string `json:"policy_status,omitempty" mapstructure:"policy_status,omitempty" desc:"Status of the policy"`
IsRunning bool `json:"is_running,omitempty" mapstructure:"is_running,omitempty" desc:"Whether the policy is currently running"`
LastRun string `json:"last_run,omitempty" mapstructure:"last_run,omitempty" desc:"Timestamp of the last run"`
LastSuccessTime string `json:"last_success_time,omitempty" mapstructure:"last_success_time,omitempty" desc:"Timestamp of the last successful run"`
}
ArkSecHubPolicyStatus represents the status of the policy.
type ArkSecHubPolicyStore ¶
type ArkSecHubPolicyStore struct {
ID string `json:"id" mapstructure:"id" desc:"Unique identifier of the store"`
Type string `json:"type,omitempty" mapstructure:"type,omitempty" desc:"Type of the store"`
Behaviors []string `json:"behaviors,omitempty" mapstructure:"behaviors,omitempty" desc:"Behaviors of the store"`
CreatedAt string `json:"created_at,omitempty" mapstructure:"created_at,omitempty" desc:"Timestamp when the store was created"`
CreatedBy string `json:"created_by,omitempty" mapstructure:"created_by,omitempty" desc:"User who created the store"`
Data map[string]interface{} `json:"data,omitempty" mapstructure:"data,omitempty" desc:"Store-specific data"`
Description string `json:"description,omitempty" mapstructure:"description,omitempty" desc:"Description of the store"`
Name string `json:"name,omitempty" mapstructure:"name,omitempty" desc:"Name of the store"`
UpdatedAt string `json:"updated_at,omitempty" mapstructure:"updated_at,omitempty" desc:"Timestamp when the store was last updated"`
UpdatedBy string `json:"updated_by,omitempty" mapstructure:"updated_by,omitempty" desc:"User who last updated the store"`
CreationDetails string `json:"creation_details,omitempty" mapstructure:"creation_details,omitempty" desc:"Creation details"`
State string `json:"state,omitempty" mapstructure:"state,omitempty" desc:"Current state of the store"`
}
ArkSecHubPolicyStore represents a reference to a store with details.
type ArkSecHubPolicyTransformation ¶
type ArkSecHubPolicyTransformation struct {
ID string `json:"id,omitempty" mapstructure:"id,omitempty" desc:"Unique identifier of the transformation"`
}
ArkSecHubPolicyTransformation represents a reference to a transformation.
type ArkSecHubSetSyncPolicyState ¶
type ArkSecHubSetSyncPolicyState struct {
PolicyID string `json:"policy_id" mapstructure:"policy_id" desc:"Unique identifier of the sync policy" validate:"required" flag:"policy-id"`
Action string `` /* 191-byte string literal not displayed */
}
ArkSecHubSetSyncPolicyState defines the structure for setting the state of a sync policy in the Ark Secrets Hub.
type ArkSecHubSyncPoliciesFilters ¶
type ArkSecHubSyncPoliciesFilters struct {
Filters string `` /* 175-byte string literal not displayed */
Projection string `` /* 182-byte string literal not displayed */
}
ArkSecHubSyncPoliciesFilters contains the policy id for the policy to retrieve
type ArkSecHubSyncPoliciesStats ¶
type ArkSecHubSyncPoliciesStats struct {
SyncPoliciesCount int `json:"sync_policies_count" mapstructure:"sync_policies_count" desc:"Overall sync policies count"`
SyncPoliciesCountByCreator map[string]int `json:"sync_policies__count_by_creator" mapstructure:"sync_policies__count_by_creator" desc:"Sync Policies count by creator"`
}
ArkSecHubSyncPoliciesStats represents the statistics of sync policies in the Ark SecHub system. It includes the total count of secret stores, a breakdown by creator, and a breakdown by type.
type ArkSechubCreateSyncPolicy ¶
type ArkSechubCreateSyncPolicy struct {
Name string `json:"name" mapstructure:"name" desc:"Name of the sync policy" flag:"name" validate:"required"`
Description string `json:"desc,omitempty" mapstructure:"desc,omitempty" desc:"Description of the sync policy" flag:"desc,omitempty"`
Source ArkSechubSyncPolicyStore `json:"source" mapstructure:"source" desc:"Source store configuration" flag:"source"`
Target ArkSechubSyncPolicyStore `json:"target" mapstructure:"target" desc:"Target store configuration" flag:"target"`
Filter ArkSechubSyncPolicyFilter `json:"filter" mapstructure:"filter" desc:"Filter for selecting items to sync" flag:"filter"`
Transformation ArkSechubSyncPolicyTransformation `json:"transformation" mapstructure:"transformation" desc:"Transformation to apply during sync" flag:"transformation"`
}
ArkSechubCreateSyncPolicy represents a sync policy for the sechub service. It includes information about the policy name, desc, source, target, filter, and transformation.
type ArkSechubSyncPolicyFilter ¶
type ArkSechubSyncPolicyFilter struct {
ID string `` /* 145-byte string literal not displayed */
Data ArkSechubSyncPolicyFilterData `json:"data,omitzero" mapstructure:"data,omitzero" desc:"Filter data" flag:"data,omitempty"`
Type string `json:"type,omitempty" mapstructure:"type,omitempty" desc:"Type of filter (PAM_SAFE)" flag:"type,omitempty" choices:"PAM_SAFE"`
}
ArkSechubSyncPolicyFilter represents a filter for selecting items to sync.
type ArkSechubSyncPolicyFilterData ¶
type ArkSechubSyncPolicyFilterData struct {
SafeName string `json:"safe_name" mapstructure:"safe_name" desc:"Name of the safe to filter" validate:"required" flag:"safe-name"`
}
ArkSechubSyncPolicyFilterData represents filter data for the sync policy.
type ArkSechubSyncPolicyStore ¶
type ArkSechubSyncPolicyStore struct {
ID string `json:"id" mapstructure:"id" desc:"Unique identifier of the store" flag:"id" validate:"required"`
}
ArkSechubSyncPolicyStore represents a store configuration with an ID.
type ArkSechubSyncPolicyTransformation ¶
type ArkSechubSyncPolicyTransformation struct {
Predefined string `` /* 181-byte string literal not displayed */
}
ArkSechubSyncPolicyTransformation represents transformation configuration for the sync policy.