Documentation
¶
Index ¶
- func Start(f ...StartOptions) error
- type StartConfig
- type StartOptions
- func WithAuthZDefaultPolicyExtension(policies [][]string) StartOptionsdeprecated
- func WithAuthZPolicy(policy string) StartOptions
- func WithConfigFile(file string) StartOptions
- func WithConfigKey(key string) StartOptions
- func WithConfigName(name string) StartOptionsdeprecated
- func WithCoreServices(services ...serviceregistry.IService) StartOptions
- func WithPublicRoutes(routes []string) StartOptions
- func WithServices(services ...serviceregistry.IService) StartOptions
- func WithWaitForShutdownSignal() StartOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Start ¶
func Start(f ...StartOptions) error
Types ¶
type StartConfig ¶
type StartOptions ¶
type StartOptions func(StartConfig) StartConfig
func WithAuthZDefaultPolicyExtension
deprecated
added in
v0.4.10
func WithAuthZDefaultPolicyExtension(policies [][]string) StartOptions
Deprecated: Use WithAuthZPolicy WithAuthZDefaultPolicyExtension option allows for extending the default casbin poliy Example:
opentdf.WithAuthZDefaultPolicyExtension([][]string{
{"p","role:admin", "pep*", "*","allow"),
}),
func WithAuthZPolicy ¶ added in v0.4.29
func WithAuthZPolicy(policy string) StartOptions
WithAuthZPolicy option sets the casbin policy to be used. Example:
opentdf.WithAuthZPolicy(strings.Join([]string{
"p, role:admin, pep*, *, allow",
"p, role:standard, pep*, read, allow",
}, "\n")),
func WithConfigFile ¶
func WithConfigFile(file string) StartOptions
WithConfigFile option sets the configuration file path.
func WithConfigKey ¶
func WithConfigKey(key string) StartOptions
WithConfigKey option sets the viper configuration key(filename).
func WithConfigName
deprecated
func WithConfigName(name string) StartOptions
Deprecated: Use WithConfigKey WithConfigName option sets the configuration name.
func WithCoreServices ¶ added in v0.4.18
func WithCoreServices(services ...serviceregistry.IService) StartOptions
WithCoreServices option adds additional core services to the platform It takes a variadic parameter of type serviceregistry.Registration, which represents the core services to be added.
func WithPublicRoutes ¶
func WithPublicRoutes(routes []string) StartOptions
WithPublicRoutes option sets the public routes for the server. It allows bypassing the authorization middleware for the specified routes. *** This should be used with caution as it can expose sensitive data. ***
func WithServices ¶ added in v0.4.18
func WithServices(services ...serviceregistry.IService) StartOptions
WithServices option adds additional services to the platform. This will set the mode for these services to the namespace name. It takes a variadic parameter of type serviceregistry.Registration, which represents the services to be added.
func WithWaitForShutdownSignal ¶
func WithWaitForShutdownSignal() StartOptions
WithWaitForShutdownSignal option allows the server to wait for a shutdown signal before exiting.
Source Files