userstore

type Accessor struct {
	ID uuid.UUID `json:"id"`

	// Name of accessor, must be unique
	Name string `json:"name" validate:"length:1,128" required:"true"`

	// Description of the accessor
	Description string `json:"description"`

	// Version of the accessor
	Version int `json:"version"`

	// Specify whether to access live or soft-deleted data
	DataLifeCycleState DataLifeCycleState `json:"data_life_cycle_state"`

	// Configuration for which user records to return
	SelectorConfig UserSelectorConfig `json:"selector_config" required:"true"`

	// Purposes for which this accessor is used
	Purposes []ResourceID `json:"purposes" validate:"skip" required:"true"`

	// List of userstore columns being accessed and the transformers to apply to each column
	Columns []ColumnOutputConfig `json:"columns" validate:"skip" required:"true"`

	// Policy for what data is returned by this accessor, based on properties of the caller and the user records
	AccessPolicy ResourceID `json:"access_policy" validate:"skip" required:"true"`

	// Policy for token resolution in the case of transformers that tokenize data
	TokenAccessPolicy ResourceID `json:"token_access_policy,omitempty" validate:"skip"`

	// Whether this accessor is a system accessor
	IsSystem bool `` /* 155-byte string literal not displayed */

	// Whether this accessor is audit logged each time it is executed
	IsAuditLogged bool `json:"is_audit_logged" description:"Whether this accessor is audit logged each time it is executed."`
}

type Address struct {
	ID                 string `json:"id,omitempty"`
	Country            string `json:"country,omitempty"`
	Name               string `json:"name,omitempty"`
	Organization       string `json:"organization,omitempty"`
	StreetAddressLine1 string `json:"street_address_line_1,omitempty"`
	StreetAddressLine2 string `json:"street_address_line_2,omitempty"`
	DependentLocality  string `json:"dependent_locality,omitempty"`
	Locality           string `json:"locality,omitempty"`
	AdministrativeArea string `json:"administrative_area,omitempty"`
	PostCode           string `json:"post_code,omitempty"`
	SortingCode        string `json:"sorting_code,omitempty"`
}

type Column struct {
	// Columns may be renamed, but their ID cannot be changed.
	ID           uuid.UUID         `json:"id"`
	Table        string            `json:"table"` // TODO (sgarrity 6/24): validate & mark as required once people update
	Name         string            `json:"name" validate:"length:1,128" required:"true"`
	DataType     ResourceID        `json:"data_type" validate:"skip"`
	Type         DataType          `json:"type" required:"true"`
	IsArray      bool              `json:"is_array" required:"true"`
	DefaultValue string            `json:"default_value"`
	IndexType    ColumnIndexType   `json:"index_type" required:"true"`
	IsSystem     bool              `` /* 149-byte string literal not displayed */
	Constraints  ColumnConstraints `json:"constraints" description:"Optional constraints for configuring the behavior of the associated column Type."`
}

type ColumnConstraints struct {
	ImmutableRequired bool          `` /* 181-byte string literal not displayed */
	PartialUpdates    bool          `` /* 226-byte string literal not displayed */
	UniqueIDRequired  bool          `` /* 222-byte string literal not displayed */
	UniqueRequired    bool          `` /* 155-byte string literal not displayed */
	Fields            []ColumnField `` /* 153-byte string literal not displayed */
}

type ColumnDataType struct {
	ID                   uuid.UUID           `json:"id"`
	Name                 string              `json:"name" validate:"length:1,128" required:"true"`
	Description          string              `json:"description"`
	IsCompositeFieldType bool                `json:"is_composite_field_type" description:"Whether the data type can be used for a composite field."`
	IsNative             bool                `json:"is_native" description:"Whether this is a native non-editable data type."`
	CompositeAttributes  CompositeAttributes `json:"composite_attributes"`
}

type ColumnField struct {
	Type                DataType `json:"type" required:"true"`
	Name                string   `` /* 290-byte string literal not displayed */
	CamelCaseName       string   `` /* 126-byte string literal not displayed */
	StructName          string   `json:"struct_name" description:"Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)"`
	Required            bool     `json:"required" description:"Whether a value must be specified for the field."`
	IgnoreForUniqueness bool     `` /* 138-byte string literal not displayed */
}

type ColumnIndexType string

type ColumnInputConfig struct {
	Column     ResourceID `json:"column"`
	Normalizer ResourceID `json:"normalizer"`

	// Validator is deprecated in favor of Normalizer
	Validator ResourceID `json:"validator"`
}

type ColumnOutputConfig struct {
	Column      ResourceID `json:"column"`
	Transformer ResourceID `json:"transformer"`
}

type CompositeAttributes struct {
	IncludeID bool             `json:"include_id" description:"Whether the composite data type must include an id field."`
	Fields    []CompositeField `json:"fields" description:"The set of fields associated with a composite data type."`
}

type CompositeField struct {
	DataType            ResourceID `json:"data_type"`
	Name                string     `` /* 290-byte string literal not displayed */
	CamelCaseName       string     `` /* 126-byte string literal not displayed */
	StructName          string     `json:"struct_name" description:"Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)"`
	Required            bool       `json:"required" description:"Whether a value must be specified for the field."`
	IgnoreForUniqueness bool       `` /* 139-byte string literal not displayed */
}

type CompositeValue map[string]interface{}

type DataLifeCycleState string

type DataType string

type Mutator struct {
	ID uuid.UUID `json:"id"`

	// Name of mutator, must be unique
	Name string `json:"name" validate:"length:1,128" required:"true"`

	// Description of the mutator
	Description string `json:"description"`

	// Version of the mutator
	Version int `json:"version"`

	// Configuration for which user records to modify
	SelectorConfig UserSelectorConfig `json:"selector_config" required:"true"`

	// The set of userstore columns to modify for each user record
	Columns []ColumnInputConfig `json:"columns" validate:"skip" required:"true"`

	// Policy for whether the data for each user record can be updated
	AccessPolicy ResourceID `json:"access_policy" validate:"skip" required:"true"`

	IsSystem bool `` /* 152-byte string literal not displayed */
}

type Purpose struct {
	ID          uuid.UUID `json:"id"`
	Name        string    `json:"name" validate:"length:1,128" required:"true"`
	Description string    `json:"description"`
	IsSystem    bool      `` /* 152-byte string literal not displayed */
}

type Record map[string]interface{}

type ResourceID struct {
	ID   uuid.UUID `json:"id"`
	Name string    `json:"name"`
}

type SQLShimDatabase struct {
	ID       uuid.UUID `json:"id"`
	Name     string    `json:"name" validate:"notempty"`
	Type     string    `json:"type" validate:"notempty"`
	Host     string    `json:"host" validate:"notempty"`
	Port     int       `json:"port" validate:"notzero"`
	Username string    `json:"username" validate:"notempty"`
	Password string    `json:"password" validate:"skip"`
}

type UserSelectorConfig struct {
	WhereClause string `json:"where_clause" validate:"notempty" example:"{id} = ANY (?)"`
}

type UserSelectorValues []interface{}