table

type AccountType int32

type Address struct {
	// Postal Code
	PostalCode string `bson:"postalCode,omitempty"`

	// Country Code
	Country string `bson:"country,omitempty"`

	// State / Province / Region / County
	State string `bson:"state,omitempty"`

	// City
	City string `bson:"city,omitempty"`

	// Address Line 1
	Addr1 string `bson:"addr1,omitempty"`

	// Address Line 2
	Addr2 string `bson:"addr2,omitempty"`

	// Address Line 3
	Addr3 string `bson:"addr3,omitempty"`

	// Name for which the address is
	Name string `bson:"name,omitempty"`
}

type ApiKeyConfig struct {
	// name of the api key, used for display purposes
	Name string `bson:"name,omitempty"`

	// ExpireAt is the timestamp when the API key will expire.
	ExpireAt int64 `bson:"expireAt,omitempty"`

	// IsDisabled indicates whether the API key is disabled.
	IsDisabled *bool `bson:"isDisabled,omitempty"`
}

type ApiKeyEntry struct {
	// ID of the API Key
	Key ApiKeyId `bson:"key"`

	// Secret is the actual secret key used for authentication.
	// It is typically a long random string that is
	// generated when the API key is created.
	// It should be kept secret and not exposed to the public.
	// It is used to authenticate the API key when making requests.
	Secret *ApiKeySecret `bson:"secret,omitempty"`

	// userinfo corresponding to this key,
	// if this field is nil, typically the key will
	// be considered invalid and no access will be
	// granted upon its usage
	UserInfo *ApiKeyUserInfo `bson:"userInfo,omitempty"`

	// created timestamp
	Created int64 `bson:"created,omitempty"`

	// last used timestamp
	LastUsed int64 `bson:"lastUsed,omitempty"`

	// config for the API key
	Config *ApiKeyConfig `bson:"config,omitempty"`
}

type ApiKeyId struct {
	// API Key ID
	Id string `bson:"id,omitempty"`
}

type ApiKeySecret struct {
	Value string `bson:"value,omitempty"`
}

type ApiKeyTable struct {
	table.Table[ApiKeyId, ApiKeyEntry]
	// contains filtered or unexported fields
}

type ApiKeyUserInfo struct {
	// Tenant to which user belongs
	Tenant string `bson:"tenant,omitempty"`

	// Username of the user who owns the API key
	Username string `bson:"username,omitempty"`
}

type Contact struct {
	// Contact Person - relevant only if address type is company
	Name string `bson:"contact,omitempty"`

	// Phone number
	Phone string `bson:"phone,omitempty"`

	// email address
	Email string `bson:"email,omitempty"`
}

type CustomerConfig struct {
	// Customer Display Name
	Name string `bson:"name,omitempty"`

	// Descriptive text for the tenant
	Desc string `bson:"desc,omitempty"`

	// Registered Address of the customer
	Addr *Address `bson:"addr,omitempty"`

	// Billing Contact for the customer
	Contact *Contact `bson:"contact,omitempty"`

	// User ID of Default Admin for the customer
	DefaultAdmin *UserCredentials `bson:"defaultAdmin,omitempty"`

	// additional customer additional bill information,
	// requirement based on local laws
	Info *TaxInfo `bson:"taxInfo,omitempty"`
}

type CustomerEntry struct {
	// Customer Key
	Key CustomerKey `bson:"key,omitempty"`

	// Customer Type Company / Personal
	Type AccountType `bson:"type,omitempty"`

	// Customer Tenancy Type Dedicated / Shared
	Tenancy TenancyType `bson:"tenancy,omitempty"`

	// Tenant Name associated with the customer
	Tenant string `bson:"tenant,omitempty"`

	// is this customer is root customer
	IsRoot bool `bson:"isRoot,omitempty"`

	// Configuration provided for the customer
	Config CustomerConfig `bson:"config,omitempty"`

	// created by
	CreatedBy string `bson:"createdBy,omitempty"`

	// created at timestamp
	Created int64 `bson:"created,omitempty"`

	// updated at timestamp
	Updated int64 `bson:"updated,omitempty"`
}

type CustomerKey struct {
	// Name or customer id as a key for the customer information
	Id string `bson:"id,omitempty"`
}

type CustomerTable struct {
	table.Table[CustomerKey, CustomerEntry]
	// contains filtered or unexported fields
}

type Email struct {
	Id string `bson:"id,omitempty"`
}

type EmailVerificationEntry struct {
	Key       *Email `bson:"key,omitempty"`
	FirstName string `bson:"firstName,omitempty"`
	LastName  string `bson:"lastName,omitempty"`
	Otp       string `bson:"otp,omitempty"`
	Created   int64  `bson:"created,omitempty"`
}

type EmailVerificationTable struct {
	table.Table[Email, EmailVerificationEntry]
	// contains filtered or unexported fields
}

type GoogleOAuth2Config struct {
	ClientID             string `json:"client_id" validate:"required"`
	ClientSecret         string `json:"client_secret" validate:"required"`
	RedirectURI          string `json:"redirect_uri,omitempty"`
	HostedDomain         string `json:"hosted_domain,omitempty"`
	Prompt               string `json:"prompt,omitempty"`
	UseUserIPParam       bool   `json:"use_userip_param"`
	RequestRefreshToken  bool   `json:"request_refresh_token"`
	AdditionalScopes     string `json:"additional_scopes,omitempty"`
	LoginHint            string `json:"login_hint,omitempty"`
	IncludeGrantedScopes bool   `json:"include_granted_scopes"`
}

type IdentityProviderEntry struct {
	Key           *IdentityProviderKey   `bson:"key,omitempty"`
	ProviderType  ProviderType           `bson:"providerType,omitempty"`
	DisplayName   string                 `bson:"displayName,omitempty"`
	DisplayOrder  int                    `bson:"displayOrder,omitempty"`
	Enabled       bool                   `bson:"enabled,omitempty"`
	Configuration map[string]interface{} `bson:"configuration,omitempty"`
	Secrets       *ProviderSecrets       `bson:"secrets,omitempty"`
	Created       int64                  `bson:"created,omitempty"`
	Updated       int64                  `bson:"updated,omitempty"`
	CreatedBy     string                 `bson:"createdBy,omitempty"`
	UpdatedBy     string                 `bson:"updatedBy,omitempty"`
}

type IdentityProviderKey struct {
	Tenant string `bson:"tenant"`
	Alias  string `bson:"alias"`
}

type IdentityProviderTable struct {
	table.Table[IdentityProviderKey, IdentityProviderEntry]
	// contains filtered or unexported fields
}

type MicrosoftOAuth2Config struct {
	ClientID         string `json:"client_id" validate:"required"`
	ClientSecret     string `json:"client_secret" validate:"required"`
	RedirectURI      string `json:"redirect_uri,omitempty"`
	TenantID         string `json:"tenant_id,omitempty"`
	Prompt           string `json:"prompt,omitempty"`
	AdditionalScopes string `json:"additional_scopes,omitempty"`
	DomainHint       string `json:"domain_hint,omitempty"`
	LoginHint        string `json:"login_hint,omitempty"`
}

type OIDCConfig struct {
	ClientID                          string `json:"client_id" validate:"required"`
	ClientSecret                      string `json:"client_secret" validate:"required"`
	DiscoveryEndpoint                 string `json:"discovery_endpoint" validate:"required"`
	RedirectURI                       string `json:"redirect_uri,omitempty"`
	UseDiscoveryEndpoint              bool   `json:"use_discovery_endpoint"`
	ClientAuthentication              string `json:"client_authentication,omitempty"`
	ClientAssertionSignatureAlgorithm string `json:"client_assertion_signature_algorithm,omitempty"`
	AdditionalScopes                  string `json:"additional_scopes,omitempty"`
	ValidateSignatures                bool   `json:"validate_signatures"`
	UseJWKSURL                        bool   `json:"use_jwks_url"`
	JWKSURL                           string `json:"jwks_url,omitempty"`
}

type OrgUnitEntry struct {
	// Org Unit Key
	Key *OrgUnitKey `bson:"key,omitempty"`

	// display name of the Org unit
	Name string `bson:"name,omitempty"`

	// description for the Org unit
	Desc string `bson:"desc,omitempty"`

	// Created timestamp
	Created int64 `bson:"created,omitempty"`

	// created by
	CreatedBy string `bson:"createdBy,omitempty"`

	// Tenant this OU belongs to
	Tenant string `bson:"tenant,omitempty"`
}

type OrgUnitKey struct {
	// id as a key for the tenant
	ID string `bson:"id,omitempty"`
}

type OrgUnitTable struct {
	table.Table[OrgUnitKey, OrgUnitEntry]
	// contains filtered or unexported fields
}

type OrgUnitUser struct {
	// org unit user key
	Key *OrgUnitUserKey `bson:"key,omitempty"`
	// created timestamp
	Created int64 `bson:"created,omitempty"`
	// created by
	CreatedBy string `bson:"createdBy,omitempty"`
	// Role assigned to the user in the org unit
	Role string `bson:"role,omitempty"`
}

type OrgUnitUserKey struct {
	// tenant name
	Tenant string `bson:"tenant,omitempty"`
	// user name
	Username string `bson:"username,omitempty"`
	// Org unit id
	OrgUnitId string `bson:"orgUnitId,omitempty"`
}

type OrgUnitUserTable struct {
	table.Table[OrgUnitUserKey, OrgUnitUser]
	// contains filtered or unexported fields
}

type ProviderConfigField struct {
	Name         string      `json:"name"`
	Type         string      `json:"type"`
	Required     bool        `json:"required"`
	Sensitive    bool        `json:"sensitive"`
	Description  string      `json:"description"`
	DefaultValue interface{} `json:"default_value,omitempty"`
	Validation   string      `json:"validation,omitempty"`
}

type ProviderMetadata struct {
	ProviderType    ProviderType          `json:"provider_type"`
	DisplayName     string                `json:"display_name"`
	Description     string                `json:"description"`
	ConfigFields    []ProviderConfigField `json:"config_fields"`
	SupportedScopes []string              `json:"supported_scopes,omitempty"`
	DefaultScopes   []string              `json:"default_scopes,omitempty"`
	Documentation   string                `json:"documentation,omitempty"`
}

type ProviderSecrets struct {
	ClientSecret      string            `bson:"clientSecret,omitempty"`
	PrivateKey        string            `bson:"privateKey,omitempty"`
	Certificate       string            `bson:"certificate,omitempty"`
	AdditionalSecrets map[string]string `bson:"additionalSecrets,omitempty"`
}

type ProviderType string

type SAMLConfig struct {
	ServiceProviderEntityID  string `json:"service_provider_entity_id" validate:"required"`
	SAMLEntityDescriptor     string `json:"saml_entity_descriptor" validate:"required"`
	SSOServiceURL            string `json:"sso_service_url" validate:"required"`
	RedirectURI              string `json:"redirect_uri,omitempty"`
	IdentityProviderEntityID string `json:"identity_provider_entity_id,omitempty"`
	SingleLogoutServiceURL   string `json:"single_logout_service_url,omitempty"`
	NameIDPolicyFormat       string `json:"nameid_policy_format,omitempty"`
	WantAuthnRequestsSigned  bool   `json:"want_authn_requests_signed"`
	ValidateSignatures       bool   `json:"validate_signatures"`
	SigningCertificate       string `json:"signing_certificate,omitempty"`
	EncryptionCertificate    string `json:"encryption_certificate,omitempty"`
	ForceAuthentication      bool   `json:"force_authentication"`
	PostBindingResponse      bool   `json:"post_binding_response"`
	PostBindingLogout        bool   `json:"post_binding_logout"`
	WantAssertionsSigned     bool   `json:"want_assertions_signed"`
	WantAssertionsEncrypted  bool   `json:"want_assertions_encrypted"`
	SignatureAlgorithm       string `json:"signature_algorithm,omitempty"`
	SAMLSignatureKeyName     string `json:"saml_signature_key_name,omitempty"`
	CanonalizationMethod     string `json:"canonicalization_method,omitempty"`
}

type TaxInfo struct {
	// Tax ID, typically GST No / VAT Number / ABN / EIN number
	TaxID string `bson:"taxId,omitempty"`

	// Personal Tax ID, typicall PAN, Social security number etc.
	PTaxID string `bson:"pTaxId,omitempty"`
}

type TenancyType int32

type TenantAdminStatus struct {
	// time when last updated
	UpdateTime int64 `bson:"updateTime,omitempty"`

	// ID of the Default Tenant Admin
	Admin string `bson:"admin,omitempty"`
}

type TenantAuthClientStatus struct {
	// time when last updated
	UpdateTime int64 `bson:"updateTime,omitempty"`

	// Client ID which is configured in Keycloak
	ClientId string `bson:"clientID,omitempty"`
}

type TenantConfig struct {
	// Display name for the tenant
	DispName string `bson:"dispName,omitempty"`

	// Descriptive text for the tenant
	Desc string `bson:"desc,omitempty"`

	// Registered Address of the tenant
	Addr *Address `bson:"addr,omitempty"`

	// Billing Contact for the tenant
	Contact *Contact `bson:"contact,omitempty"`

	// User ID of Default Admin for the tenant
	DefaultAdmin *UserCredentials `bson:"defaultAdmin,omitempty"`

	// additional tenant information, requirement based on
	// local laws
	Info *TaxInfo `bson:"info,omitempty"`

	// is this tenant root tenant
	IsRoot bool `bson:"isRoot,omitempty"`
}

type TenantEntry struct {
	// Tenant Type Company / Personal
	Type AccountType `bson:"type,omitempty"`

	// Configuration provided for the tenant
	Config *TenantConfig `bson:"config,omitempty"`

	// keycloak Status - as per the setup manager
	KCStatus *TenantKCStatus `bson:"kcStatus,omitempty"`

	// Roles status - as per roles manager
	RoleStatus *TenantRoleStatus `bson:"roleStatus,omitempty"`

	// admin status
	AdminStatus *TenantAdminStatus `bson:"adminStatus,omitempty"`

	// auth client status
	AuthClient *TenantAuthClientStatus `bson:"authClient,omitempty"`
}

type TenantKCStatus struct {
	// time when last updated
	UpdateTime int64 `bson:"updateTime,omitempty"`

	// realm name which is configured in Keycloak
	RealmName string `bson:"realmName,omitempty"`
}

type TenantKey struct {
	// Name as a key for the tenant
	Name string `bson:"name,omitempty"`
}

type TenantRoleStatus struct {
	// time when last updated
	UpdateTime int64 `bson:"updateTime,omitempty"`
}

type TenantTable struct {
	table.Table[TenantKey, TenantEntry]
	// contains filtered or unexported fields
}

type UserCredentials struct {
	// User Id - username or email id using which user would login
	UserID string `bson:"userID,omitempty"`

	// Password - first time password for the user
	// this will be stored by cryptographically encoding
	Password string `bson:"password,omitempty"`
}

type UserEntry struct {
	Key        *UserKey            `bson:"key,omitempty"`
	Created    int64               `bson:"created,omitempty"`
	Updated    int64               `bson:"updated,omitempty"`
	LastAccess int64               `bson:"lastAccess,omitempty"`
	Info       *UserInfo           `bson:"info,omitempty"`
	Password   *UserTempPassword   `bson:"password,omitempty"`
	Disabled   *bool               `bson:"disabled,omitempty"`
	Deleted    *bool               `bson:"deleted,omitempty"`
	KCStatus   *UserKeycloakStatus `bson:"kcStatus,omitempty"`
	RealmRoles *[]string           `bson:"realmRoles,omitempty"`
}

type UserInfo struct {
	FirstName string `bson:"firstName,omitempty"`
	LastName  string `bson:"lastName,omitempty"`
	Email     string `bson:"email,omitempty"`
}

type UserKey struct {
	Tenant   string `bson:"tenant,omitempty"`
	Username string `bson:"username,omitempty"`
}

type UserKeycloakStatus struct {
	Updated  int64 `bson:"updated,omitempty"`
	Disabled *bool `bson:"disabled,omitempty"`
}

type UserPreferenceEntry struct {
	Key       *UserKey `bson:"key,omitempty"`
	DefaultOU *string  `bson:"defaultOU,omitempty"`
}

type UserPreferenceTable struct {
	table.Table[UserKey, UserPreferenceEntry]
	// contains filtered or unexported fields
}

type UserTable struct {
	table.Table[UserKey, UserEntry]
	// contains filtered or unexported fields
}

type UserTempPassword struct {
	Value string `bson:"val,omitempty"`
}

type ValidationError struct {
	Field   string
	Message string
}