api

package

v0.0.15 Latest Latest Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SENERGY-Platform/authorization

Links

Open Source Insights

Documentation ¶

Index ¶

func AccessEndpoint(router *gin.Engine, _ configuration.Config, _ util.Jwt, ...)
func AllowedEndpoints(router *gin.Engine, _ configuration.Config, jwt util.Jwt, ...)
func CheckEndpoints(router *gin.Engine, _ configuration.Config, jwt util.Jwt, ...)
func DocEndpoint(router *gin.Engine, _ configuration.Config, _ util.Jwt, _ *authorization.Guard)
func ErrorHandler(f func(error) int, sep string) gin.HandlerFunc
func PoliciesEndpoints(router *gin.Engine, _ configuration.Config, _ util.Jwt, ...)
func Start(ctx context.Context, wg *sync.WaitGroup, config configuration.Config, ...) (err error)
func TestEndpoints(router *gin.Engine, _ configuration.Config, _ util.Jwt, ...)
type ErrorResponse
type KongMessage
type TestResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AccessEndpoint ¶

func AccessEndpoint(router *gin.Engine, _ configuration.Config, _ util.Jwt, guard *authorization.Guard)

func AllowedEndpoints ¶

func AllowedEndpoints(router *gin.Engine, _ configuration.Config, jwt util.Jwt, guard *authorization.Guard)

func CheckEndpoints ¶

func CheckEndpoints(router *gin.Engine, _ configuration.Config, jwt util.Jwt, guard *authorization.Guard)

func DocEndpoint ¶ added in v0.0.7

func DocEndpoint(router *gin.Engine, _ configuration.Config, _ util.Jwt, _ *authorization.Guard)

func ErrorHandler ¶ added in v0.0.8

func ErrorHandler(f func(error) int, sep string) gin.HandlerFunc

func PoliciesEndpoints ¶

func PoliciesEndpoints(router *gin.Engine, _ configuration.Config, _ util.Jwt, guard *authorization.Guard)

func Start ¶

func Start(ctx context.Context, wg *sync.WaitGroup, config configuration.Config, guard *authorization.Guard) (err error)

Start godoc @title Authorization API @description Allows definition of policies and checking of access rights. @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization

func TestEndpoints ¶

func TestEndpoints(router *gin.Engine, _ configuration.Config, _ util.Jwt, guard *authorization.Guard)

Types ¶

type ErrorResponse ¶ added in v0.0.7

type ErrorResponse string

type KongMessage ¶

type KongMessage struct {
	Result bool   `json:"result"`
	Error  string `json:"error"`
}

type TestResponse ¶

type TestResponse struct {
	Get    bool `json:"GET"`
	Post   bool `json:"POST"`
	Put    bool `json:"PUT"`
	Patch  bool `json:"PATCH"`
	Delete bool `json:"DELETE"`
	Head   bool `json:"HEAD"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
util

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL