dtos

Documentation

Index

• type APIKey
• type AuthenticationInfo
• type DetailedAuthenticationInfo
• type Evidence
• type Finding
• type Operation
• type PaginationWrapper
• type Query
• type SupportedAuthScheme
• type Tag
• type TagDifference
• type TagPair
• type User
• type UserAdminView
• type UserOperationRole
• type UserOwnView

Types

type APIKey

type APIKey struct {
	AccessKey string     `json:"accessKey"`
	SecretKey []byte     `json:"secretKey"`
	LastAuth  *time.Time `json:"lastAuth"`
}

type AuthenticationInfo

type AuthenticationInfo struct {
	UserKey        string     `json:"userKey"`
	AuthSchemeName *string    `json:"schemeName,omitempty"`
	AuthSchemeCode string     `json:"schemeCode"`
	AuthLogin      *time.Time `json:"lastLogin"`
}

type DetailedAuthenticationInfo

type DetailedAuthenticationInfo struct {
	AuthSchemeName  string     `json:"schemeName"`
	AuthSchemeCode  string     `json:"schemeCode"`
	UserCount       int64      `json:"userCount"`
	UniqueUserCount int64      `json:"uniqueUserCount"`
	LastUsed        *time.Time `json:"lastUsed"`
	Labels          []string   `json:"labels"`
}

type Evidence

type Evidence struct {
	UUID        string    `json:"uuid"`
	Description string    `json:"description"`
	OccurredAt  time.Time `json:"occurredAt"`
	Operator    User      `json:"operator"`
	Tags        []Tag     `json:"tags"`
	ContentType string    `json:"contentType"`
}

type Finding

type Finding struct {
	UUID          string     `json:"uuid"`
	Title         string     `json:"title"`
	Description   string     `json:"description"`
	Operators     []User     `json:"operators"`
	ReadyToReport bool       `json:"readyToReport"`
	TicketLink    *string    `json:"ticketLink"`
	Tags          []Tag      `json:"tags"`
	NumEvidence   int        `json:"numEvidence"`
	Category      string     `json:"category"`
	OccurredFrom  *time.Time `json:"occurredFrom"`
	OccurredTo    *time.Time `json:"occurredTo"`
}

type Operation

type Operation struct {
	Slug     string                 `json:"slug"`
	Name     string                 `json:"name"`
	NumUsers int                    `json:"numUsers"`
	Status   models.OperationStatus `json:"status"`

	// ID is only used in list operations for the API since the screenshot client still expects int64 ids.
	// Once the screenshot client is updated this line can be removed
	ID int64 `json:"id"`
}

type PaginationWrapper

type PaginationWrapper struct {
	Content    interface{} `json:"content"`
	PageNumber int64       `json:"page"`
	PageSize   int64       `json:"pageSize"`
	TotalCount int64       `json:"totalCount"`
	TotalPages int64       `json:"totalPages"`
}

type Query

type Query struct {
	ID    int64  `json:"id"`
	Name  string `json:"name"`
	Query string `json:"query"`
	Type  string `json:"type"`
}

type SupportedAuthScheme

type SupportedAuthScheme struct {
	SchemeName string `json:"schemeName"`
	SchemeCode string `json:"schemeCode"`
}

type Tag

type Tag struct {
	ID        int64  `json:"id"`
	ColorName string `json:"colorName"`
	Name      string `json:"name"`
}

type TagDifference

type TagDifference struct {
	Included []TagPair `json:"included"`
	Excluded []Tag     `json:"excluded"`
}

type TagPair

type TagPair struct {
	SourceTag      Tag `json:"sourceTag"`
	DestinationTag Tag `json:"destinationTag"`
}

type User

type User struct {
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
	Slug      string `json:"slug"`
}

type UserAdminView

type UserAdminView struct {
	User
	Email       string   `json:"email"`
	Admin       bool     `json:"admin,omitempty"`
	Headless    bool     `json:"headless"`
	Disabled    bool     `json:"disabled"`
	Deleted     bool     `json:"deleted"`
	AuthSchemes []string `json:"authSchemes"`
}

type UserOperationRole

type UserOperationRole struct {
	User User                 `json:"user"`
	Role policy.OperationRole `json:"role"`
}

type UserOwnView

type UserOwnView struct {
	User
	Email          string               `json:"email"`
	Admin          bool                 `json:"admin"`
	Authentication []AuthenticationInfo `json:"authSchemes"`
	Headless       bool                 `json:"headless"`
}