api

package
v0.0.10 Latest Latest
Warning

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

 Go to latest Published: May 26, 2022 License: MPL-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const CustomPolicyDefaultPriority int = 100
View Source 
const DataAccessPermissionApiPrefix = "/api/v1/data-access-permission"
View Source 
const DataAccessSelfServiceApiPrefix = "/api/v1/data-access-self-service"
View Source 
const DataPolicyApiPrefix = "/api/v1/data-policy"
View Source 
const DataPolicyPermissionsSuffix = "permissions"
View Source 
const DataPolicyRulesSuffix = "rules"
View Source 
const DataPolicySecurityPoliciesSuffix = "security-policies"
View Source 
const DataSetApiPrefix = "/api/v1/dataset"
View Source 
const DataStoreApiPrefix = "/api/v1/datastore"
View Source 
const DirectoryGroupApiPrefix = "/api/v1/directory/group"
View Source 
const HostURL string = "https://app.satoricyber.com"

HostURL - Default Satori URL

View Source 
const MaskingProfileApiPrefix = "/api/v1/masking"
View Source 
const SecurityPolicyApiPrefix = "/api/v1/security-policies"
View Source 
const TaxonomyApiPrefix = "/api/v1/taxonomy/custom"
View Source 
const TaxonomyCategoryApiPrefix = TaxonomyApiPrefix + "/category"
View Source 
const TaxonomyClassifierApiPrefix = TaxonomyApiPrefix + "/classifier"
View Source 
const UsersApiPrefix = "/api/v1/users"

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControl 

type AccessControl struct {
	AccessControlEnabled bool `json:"permissionsEnabled"`
	UserRequestsEnabled  bool `json:"accessRequestsEnabled"`
	SelfServiceEnabled   bool `json:"selfServiceAccessEnabled"`
}

type AuthResponse 

type AuthResponse struct {
	Token string `json:"token"`
}

type AuthStruct 

type AuthStruct struct {
	Username string `json:"serviceAccountId"`
	Password string `json:"serviceAccountKey"`
}

type BaselineSecurityPolicy added in v0.0.5 

type BaselineSecurityPolicy struct {
	Type                        string                      `json:"type,omitempty"`
	UnassociatedQueriesCategory UnassociatedQueriesCategory `json:"unassociatedQueriesCategory"`
	UnsupportedQueriesCategory  UnsupportedQueriesCategory  `json:"unsupportedQueriesCategory"`
	Exclusions                  Exclusions                  `json:"exclusions"`
}

type Client 

type Client struct {
	HostURL    string
	HTTPClient *http.Client
	Token      string
	AccountId  string
	UserAgent  string
}

func NewClient 

func NewClient(host, userAgent, accountId, username, password *string, verifyTls bool) (*Client, error)

func (*Client) CreateDataAccessPermission 

func (c *Client) CreateDataAccessPermission(parentId string, input *DataAccessPermission) (*DataAccessPermission, error)

func (*Client) CreateDataAccessSelfServiceRule 

func (c *Client) CreateDataAccessSelfServiceRule(parentId string, input *DataAccessSelfServiceRule) (*DataAccessSelfServiceRule, error)

func (*Client) CreateDataSet 

func (c *Client) CreateDataSet(input *DataSet) (*DataSetOutput, error)

func (*Client) CreateDataStore added in v0.0.5 

func (c *Client) CreateDataStore(input *DataStore) (*DataStoreOutput, error)

func (*Client) CreateDirectoryGroup 

func (c *Client) CreateDirectoryGroup(input *DirectoryGroup) (*DirectoryGroup, error)

func (*Client) CreateMaskingProfile added in v0.0.3 

func (c *Client) CreateMaskingProfile(input *MaskingProfile) (*MaskingProfileOutput, error)

func (*Client) CreateSecurityPolicy added in v0.0.3 

func (c *Client) CreateSecurityPolicy(input *SecurityPolicy) (*SecurityPolicyOutput, error)

func (*Client) CreateTaxonomyCategory added in v0.0.2 

func (c *Client) CreateTaxonomyCategory(input *TaxonomyCategory) (*TaxonomyCategoryOutput, error)

func (*Client) CreateTaxonomyClassifier added in v0.0.2 

func (c *Client) CreateTaxonomyClassifier(input *TaxonomyClassifier) (*TaxonomyClassifierOutput, error)

func (*Client) DeleteDataAccessPermission 

func (c *Client) DeleteDataAccessPermission(id string) error

func (*Client) DeleteDataAccessSelfServiceRule 

func (c *Client) DeleteDataAccessSelfServiceRule(id string) error

func (*Client) DeleteDataSet 

func (c *Client) DeleteDataSet(id string) error

func (*Client) DeleteDataStore added in v0.0.5 

func (c *Client) DeleteDataStore(id string) error

func (*Client) DeleteDirectoryGroup 

func (c *Client) DeleteDirectoryGroup(id string) error

func (*Client) DeleteMaskingProfile added in v0.0.3 

func (c *Client) DeleteMaskingProfile(id string) error

func (*Client) DeleteSecurityPolicy added in v0.0.3 

func (c *Client) DeleteSecurityPolicy(id string) error

func (*Client) DeleteTaxonomyNode added in v0.0.2 

func (c *Client) DeleteTaxonomyNode(id string) error

func (*Client) GetAccessControl 

func (c *Client) GetAccessControl(id string) (*AccessControl, error)

func (*Client) GetCustomPolicy 

func (c *Client) GetCustomPolicy(id string) (*CustomPolicy, error)

func (*Client) GetDataAccessPermission 

func (c *Client) GetDataAccessPermission(id string) (*DataAccessPermission, error, int)

func (*Client) GetDataAccessSelfServiceRule 

func (c *Client) GetDataAccessSelfServiceRule(id string) (*DataAccessSelfServiceRule, error, int)

func (*Client) GetDataSet 

func (c *Client) GetDataSet(id string) (*DataSetOutput, error, int)

func (*Client) GetDataStore added in v0.0.5 

func (c *Client) GetDataStore(id string) (*DataStoreOutput, error, int)

func (*Client) GetDirectoryGroup 

func (c *Client) GetDirectoryGroup(id string) (*DirectoryGroup, error, int)

func (*Client) GetMaskingProfile added in v0.0.3 

func (c *Client) GetMaskingProfile(id string) (*MaskingProfileOutput, error, int)

func (*Client) GetSecurityPolicies 

func (c *Client) GetSecurityPolicies(id string) (*SecurityPolicies, error)

func (*Client) GetSecurityPolicy added in v0.0.3 

func (c *Client) GetSecurityPolicy(id string) (*SecurityPolicyOutput, error, int)

func (*Client) GetTaxonomyCategory added in v0.0.2 

func (c *Client) GetTaxonomyCategory(id string) (*TaxonomyCategoryOutput, error, int)

func (*Client) GetTaxonomyClassifier added in v0.0.2 

func (c *Client) GetTaxonomyClassifier(id string) (*TaxonomyClassifierOutput, error, int)

func (*Client) QueryUsers 

func (c *Client) QueryUsers(search *string) ([]User, error)

func (*Client) UpdateAccessControl 

func (c *Client) UpdateAccessControl(id string, input *AccessControl) (*AccessControl, error)

func (*Client) UpdateCustomPolicy 

func (c *Client) UpdateCustomPolicy(id string, input *CustomPolicy) (*CustomPolicy, error)

func (*Client) UpdateDataAccessPermission 

func (c *Client) UpdateDataAccessPermission(id string, input *DataAccessPermission) (*DataAccessPermission, error)

func (*Client) UpdateDataAccessPermissionSuspendedStatus 

func (c *Client) UpdateDataAccessPermissionSuspendedStatus(id string, suspend bool) (*DataAccessPermission, error)

func (*Client) UpdateDataAccessSelfServiceRule 

func (c *Client) UpdateDataAccessSelfServiceRule(id string, input *DataAccessSelfServiceRule) (*DataAccessSelfServiceRule, error)

func (*Client) UpdateDataSet 

func (c *Client) UpdateDataSet(id string, input *DataSet) (*DataSetOutput, error)

func (*Client) UpdateDataStore added in v0.0.5 

func (c *Client) UpdateDataStore(id string, input *DataStore) (*DataStoreOutput, error)

func (*Client) UpdateDirectoryGroup 

func (c *Client) UpdateDirectoryGroup(id string, input *DirectoryGroup) (*DirectoryGroup, error)

func (*Client) UpdateMaskingProfile added in v0.0.3 

func (c *Client) UpdateMaskingProfile(id string, input *MaskingProfile) (*MaskingProfileOutput, error)

func (*Client) UpdateSecurityPolicies 

func (c *Client) UpdateSecurityPolicies(id string, input *SecurityPolicies) (*SecurityPolicies, error)

func (*Client) UpdateSecurityPolicy added in v0.0.3 

func (c *Client) UpdateSecurityPolicy(id string, input *SecurityPolicy) (*SecurityPolicyOutput, error)

func (*Client) UpdateTaxonomyCategory added in v0.0.2 

func (c *Client) UpdateTaxonomyCategory(id string, input *TaxonomyCategory) (*TaxonomyCategoryOutput, error)

func (*Client) UpdateTaxonomyClassifier added in v0.0.2 

func (c *Client) UpdateTaxonomyClassifier(id string, input *TaxonomyClassifier) (*TaxonomyClassifierOutput, error)

type Credentials added in v0.0.7 

type Credentials struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type CustomPolicy 

type CustomPolicy struct {
	Priority  int    `json:"priority"`
	RulesYaml string `json:"rulesYaml"`
	TagsYaml  string `json:"tagsYaml"`
}

type DataAccessIdentity 

type DataAccessIdentity struct {
	IdentityType string `json:"identityType"`
	Identity     string `json:"identity"`
}

type DataAccessPermission 

type DataAccessPermission struct {
	Id               *string                   `json:"id,omitempty"`
	ParentId         *string                   `json:"parentId,omitempty"`
	Suspended        *bool                     `json:"suspended,omitempty"`
	Identity         *DataAccessIdentity       `json:"identity,omitempty"`
	AccessLevel      string                    `json:"accessLevel"`
	TimeLimit        DataAccessTimeLimit       `json:"timeLimit"`
	UnusedTimeLimit  DataAccessUnusedTimeLimit `json:"unusedTimeLimit"`
	SecurityPolicies *[]string                 `json:"securityPolicyIds,omitempty"`
}

type DataAccessSelfServiceRule 

type DataAccessSelfServiceRule struct {
	Id               *string                        `json:"id,omitempty"`
	ParentId         *string                        `json:"parentId,omitempty"`
	Identity         *DataAccessIdentity            `json:"identity,omitempty"`
	AccessLevel      string                         `json:"accessLevel"`
	TimeLimit        DataAccessSelfServiceTimeLimit `json:"timeLimit"`
	UnusedTimeLimit  DataAccessUnusedTimeLimit      `json:"unusedTimeLimit"`
	SecurityPolicies *[]string                      `json:"securityPolicyIds,omitempty"`
}

type DataAccessSelfServiceTimeLimit 

type DataAccessSelfServiceTimeLimit struct {
	ShouldExpire bool   `json:"shouldExpire"`
	UnitType     string `json:"unitType"`
	Units        int    `json:"units"`
}

type DataAccessTimeLimit 

type DataAccessTimeLimit struct {
	Expiration   *interface{} `json:"expiration,omitempty"`
	ShouldExpire bool         `json:"shouldExpire"`
}

type DataAccessUnusedTimeLimit 

type DataAccessUnusedTimeLimit struct {
	UnusedDaysUntilRevocation int  `json:"unusedDaysUntilRevocation"`
	ShouldRevoke              bool `json:"shouldRevoke"`
}

type DataFilterCriteria added in v0.0.3 

type DataFilterCriteria struct {
	Condition string             `json:"condition"`
	Identity  DataAccessIdentity `json:"identity"`
}

type DataFilterDefaultValues added in v0.0.4 

type DataFilterDefaultValues struct {
	Type   string    `json:"type"` //   STRING, NUMERIC, NO_VALUE, ALL_OTHER_VALUES
	Values *[]string `json:"values,omitempty"`
}

type DataFilterValues added in v0.0.4 

type DataFilterValues struct {
	Type   string    `json:"type"` //   STRING, NUMERIC, ANY_VALUE, ALL_OTHER_VALUES
	Values *[]string `json:"values"`
}

type DataSet 

type DataSet struct {
	Name             string            `json:"name"`
	Description      string            `json:"description"`
	OwnersIds        []string          `json:"ownersIds"`
	IncludeLocations []DataSetLocation `json:"includeLocations"`
	ExcludeLocations []DataSetLocation `json:"excludeLocations"`
}

type DataSetGenericLocation 

type DataSetGenericLocation struct {
	Type   string  `json:"type"`
	Db     *string `json:"db,omitempty"`
	Schema *string `json:"schema,omitempty"`
	Table  *string `json:"table,omitempty"`
}

type DataSetLocation 

type DataSetLocation struct {
	DataStoreId string                  `json:"dataStoreId"`
	Location    *DataSetGenericLocation `json:"location,omitempty"`
}

type DataSetOutput 

type DataSetOutput struct {
	Id               string            `json:"id"`
	Name             string            `json:"name"`
	Description      string            `json:"description"`
	OwnersIds        []string          `json:"ownersIds"`
	IncludeLocations []DataSetLocation `json:"includeLocations"`
	ExcludeLocations []DataSetLocation `json:"excludeLocations"`
	DataPolicyId     string            `json:"dataPolicyId"`
}

type DataStore added in v0.0.5 

type DataStore struct {
	Name                   string                  `json:"name"`
	Hostname               string                  `json:"hostname"`
	OriginPort             int                     `json:"originPort,omitempty"`
	Type                   string                  `json:"type"`
	DataAccessControllerId string                  `json:"dataAccessControllerId"`
	BaselineSecurityPolicy *BaselineSecurityPolicy `json:"baselineSecurityPolicy,omitempty"`
	ProjectIds             []string                `json:"projectIds,omitempty"`
	CustomIngressPort      int                     `json:"customIngressPort,omitempty"`
	NetworkPolicy          *NetworkPolicy          `json:"networkPolicy,omitempty"`
	SatoriAuthSettings     *SatoriAuthSettings     `json:"satoriAuthSettings,omitempty"`
}

type DataStoreOutput added in v0.0.5 

type DataStoreOutput struct {
	Id                     string                  `json:"id"`
	Name                   string                  `json:"name"`
	Hostname               string                  `json:"hostname"`
	OriginPort             int                     `json:"originPort"`
	CustomIngressPort      int                     `json:"customIngressPort,omitempty"`
	Type                   string                  `json:"type"`
	DataPolicyId           string                  `json:"dataPolicyId"`
	DataAccessControllerId string                  `json:"dataAccessControllerId"`
	BaselineSecurityPolicy *BaselineSecurityPolicy `json:"baselineSecurityPolicy,omitempty"`
	ProjectIds             []string                `json:"projectIds,omitempty"`
	NetworkPolicy          *NetworkPolicy          `json:"networkPolicy,omitempty"`
	SatoriAuthSettings     *SatoriAuthSettings     `json:"satoriAuthSettings,omitempty"`
}

type DirectoryGroup 

type DirectoryGroup struct {
	Id          *string                `json:"id,omitempty"`
	Name        string                 `json:"name"`
	Description *string                `json:"description,omitempty"`
	Members     []DirectoryGroupMember `json:"members"`
}

type DirectoryGroupMember 

type DirectoryGroupMember struct {
	Type     string  `json:"type"`
	Name     *string `json:"name,omitempty"`
	DsType   *string `json:"dsType,omitempty"`
	Provider *string `json:"provider,omitempty"`
	GroupId  *string `json:"id,omitempty"`
}

type ExcludedIdentities added in v0.0.5 

type ExcludedIdentities struct {
	IdentityType string `json:"identityType"`
	Identity     string `json:"identity"`
}

type ExcludedQueryPatterns added in v0.0.5 

type ExcludedQueryPatterns struct {
	Pattern string `json:"pattern"`
}

type Exclusions added in v0.0.5 

type Exclusions struct {
	ExcludedIdentities    []ExcludedIdentities    `json:"excludedIdentities"`
	ExcludedQueryPatterns []ExcludedQueryPatterns `json:"excludedQueryPatterns"`
}

type IpRanges added in v0.0.6 

type IpRanges struct {
	IpRange string `json:"ipRange,omitempty"`
}

type MaskingAction added in v0.0.3 

type MaskingAction struct {
	MaskingProfileId string `json:"maskingProfileId"`
	Type             string `json:"type"`
}

type MaskingCondition added in v0.0.3 

type MaskingCondition struct {
	Tag         string  `json:"tag"`
	Type        string  `json:"type"`
	Replacement *string `json:"replacement,omitempty"`
	Truncate    int     `json:"truncate,omitempty"`
}

type MaskingProfile added in v0.0.3 

type MaskingProfile struct {
	Name        string             `json:"name"`
	Description *string            `json:"description,omitempty"`
	MaskConfigs []MaskingCondition `json:"maskConfigs"`
}

type MaskingProfileOutput added in v0.0.3 

type MaskingProfileOutput struct {
	MaskingProfile
	Id string `json:"id"`
}

type MaskingRule added in v0.0.3 

type MaskingRule struct {
	Id                 string             `json:"id"`
	Active             bool               `json:"active"`
	Description        string             `json:"description"`
	DataFilterCriteria DataFilterCriteria `json:"criteria"`
	MaskingAction      MaskingAction      `json:"maskingAction"`
}

type MaskingSecurityProfile added in v0.0.3 

type MaskingSecurityProfile struct {
	Active bool          `json:"active"`
	Rules  []MaskingRule `json:"rules"`
}

/////////////////// Masking ///////////////////

type NetworkPolicy added in v0.0.6 

type NetworkPolicy struct {
	AllowedRules []NetworkPolicyRules `json:"allowedRules,omitempty"`
	BlockedRules []NetworkPolicyRules `json:"blockedRules,omitempty"`
}

type NetworkPolicyRules added in v0.0.6 

type NetworkPolicyRules struct {
	Note     string     `json:"note,omitempty"`
	IPRanges []IpRanges `json:"ipRanges,omitempty"`
}

type RowLevelSecurityFilter added in v0.0.4 

type RowLevelSecurityFilter struct {
	Name     string                          `json:"name"`
	Filters  []RowLevelSecurityMapDataFilter `json:"filters"`
	Defaults DataFilterDefaultValues         `json:"defaults"`
}

type RowLevelSecurityMapDataFilter added in v0.0.4 

type RowLevelSecurityMapDataFilter struct {
	Criteria DataFilterCriteria `json:"criteria"`
	Values   DataFilterValues   `json:"values"`
}

type RowLevelSecurityProfile added in v0.0.3 

type RowLevelSecurityProfile struct {
	Active bool                     `json:"active"`
	Rules  []RowLevelSecurityRule   `json:"rules"`
	Maps   []RowLevelSecurityFilter `json:"maps"`
}

type RowLevelSecurityRule added in v0.0.4 

type RowLevelSecurityRule struct {
	Id          string                     `json:"id"`
	Active      bool                       `json:"active"`
	Description string                     `json:"description"`
	RuleFilter  RowLevelSecurityRuleFilter `json:"filter"`
}

type RowLevelSecurityRuleFilter added in v0.0.4 

type RowLevelSecurityRuleFilter struct {
	DataStoreId    string                  `json:"dataStoreId"`
	LocationPrefix *DataSetGenericLocation `json:"locationPrefix"`
	LogicYaml      string                  `json:"logicYaml"`
	Advanced       bool                    `json:"advanced"`
}

/////////////////// Row Level Security ///////////////////

type SatoriAuthSettings added in v0.0.7 

type SatoriAuthSettings struct {
	Enabled     bool        `json:"enabled,omitempty"`
	Credentials Credentials `json:"credentials,omitempty"`
}

type SecurityPolicies 

type SecurityPolicies struct {
	Ids []string `json:"defaultSecurityPolicyIds"`
}

type SecurityPolicy added in v0.0.3 

type SecurityPolicy struct {
	Name             string           `json:"name"`
	SecurityProfiles SecurityProfiles `json:"profiles"`
}

type SecurityPolicyOutput added in v0.0.3 

type SecurityPolicyOutput struct {
	SecurityPolicy
	Id string `json:"id"`
}

type SecurityProfiles added in v0.0.3 

type SecurityProfiles struct {
	Masking          *MaskingSecurityProfile  `json:"masking,omitempty"`
	RowLevelSecurity *RowLevelSecurityProfile `json:"rowLevelSecurity,omitempty"`
}

type TaxonomyCategory added in v0.0.2 

type TaxonomyCategory struct {
	Name        string  `json:"name"`
	Description *string `json:"description"`
	ParentNode  *string `json:"parentNode"`
	Color       string  `json:"color"`
}

type TaxonomyCategoryOutput added in v0.0.2 

type TaxonomyCategoryOutput struct {
	Id          string  `json:"id"`
	Name        string  `json:"name"`
	Tag         string  `json:"tag"`
	Description *string `json:"description,omitempty"`
	ParentNode  *string `json:"parentNode,omitempty"`
	Color       string  `json:"color"`
}

type TaxonomyClassifier added in v0.0.2 

type TaxonomyClassifier struct {
	Name        string                   `json:"name"`
	Description *string                  `json:"description"`
	ParentNode  string                   `json:"parentNode"`
	Scope       TaxonomyClassifierScope  `json:"scope"`
	Config      TaxonomyClassifierConfig `json:"config"`
}

type TaxonomyClassifierConfig added in v0.0.2 

type TaxonomyClassifierConfig struct {
	Type                   string                    `json:"type"`
	FieldNamePattern       *string                   `json:"fieldNamePattern,omitempty"`
	SatoriBaseClassifierId *string                   `json:"satoriBaseClassifierId,omitempty"`
	FieldType              *string                   `json:"fieldType,omitempty"`
	Values                 *TaxonomyClassifierValues `json:"values,omitempty"`
	AdditionalCategories   []string                  `json:"additionalSatoriCategoriesToTag"`
}

type TaxonomyClassifierOutput added in v0.0.2 

type TaxonomyClassifierOutput struct {
	Id          string                   `json:"id"`
	Name        string                   `json:"name"`
	Tag         string                   `json:"tag"`
	Description *string                  `json:"description"`
	ParentNode  string                   `json:"parentNode"`
	Scope       TaxonomyClassifierScope  `json:"scope"`
	Config      TaxonomyClassifierConfig `json:"config"`
}

type TaxonomyClassifierScope added in v0.0.2 

type TaxonomyClassifierScope struct {
	DatasetIds       []string          `json:"datasetIds"`
	IncludeLocations []DataSetLocation `json:"includeLocations"`
}

type TaxonomyClassifierValues added in v0.0.2 

type TaxonomyClassifierValues struct {
	Values          *[]string `json:"values,omitempty"`
	CaseInsensitive bool      `json:"caseInsensitive"`
	Regex           bool      `json:"regex"`
}

type UnassociatedQueriesCategory added in v0.0.5 

type UnassociatedQueriesCategory struct {
	QueryAction string `json:"queryAction"`
}

type UnsupportedQueriesCategory added in v0.0.5 

type UnsupportedQueriesCategory struct {
	QueryAction string `json:"queryAction"`
}

type User 

type User struct {
	Id    string `json:"id"`
	Email string `json:"email"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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