auth

Documentation

Index

• func AddAppIDToCtx(ctx context.Context, value string) context.Context
• func AddServiceNameToCtx(ctx context.Context, value string) context.Context
• func AddUserIDToCtx(ctx context.Context, userID string) context.Context
• func AddUserRoleToCtx(ctx context.Context, value string) context.Context
• func GetAppID(ctx context.Context) string
• func GetAppPlatform(ctx context.Context) string
• func GetAppVersion(ctx context.Context) string
• func GetIdentity(ctx context.Context) (string, string, error)
• func GetServiceName(ctx context.Context) string
• func GetTraceID(ctx context.Context) string
• func GetUserID(ctx context.Context) (string, error)
• func GetUserRole(ctx context.Context) (string, error)
• func IsAdmin(ctx context.Context) bool
• func IsBanned(ctx context.Context) bool
• func IsGuest(ctx context.Context) bool
• func ToAdminCtx(ctx context.Context) context.Context
• func ToBannedCtx(ctx context.Context) context.Context
• func ToGuestCtx(ctx context.Context) context.Context
• func WithAppPlatform(ctx context.Context, platform string) context.Context
• func WithAppVersion(ctx context.Context, platform string) context.Context
• func WithTraceID(ctx context.Context, traceID string) context.Context

Functions

func AddAppIDToCtx

func AddAppIDToCtx(ctx context.Context, value string) context.Context

AddAppIDToCtx store authenticated user id to context

func AddServiceNameToCtx

func AddServiceNameToCtx(ctx context.Context, value string) context.Context

AddServiceNameToCtx store authenticated user id to context

func AddUserIDToCtx

func AddUserIDToCtx(ctx context.Context, userID string) context.Context

AddUserIDToCtx store authenticated user id to context

func AddUserRoleToCtx

func AddUserRoleToCtx(ctx context.Context, value string) context.Context

AddUserRoleToCtx adds user role to context

func GetAppID

func GetAppID(ctx context.Context) string

GetAppID gets authenticated app id from context

func GetAppPlatform

func GetAppPlatform(ctx context.Context) string

GetAppPlatform returns application platform of the context.

func GetAppVersion

func GetAppVersion(ctx context.Context) string

GetAppVersion returns application version of the context.

func GetIdentity

func GetIdentity(ctx context.Context) (string, string, error)

GetIdentity returns the app and user IDs and an error in case both are empty

func GetServiceName

func GetServiceName(ctx context.Context) string

GetServiceName gets authenticated service name from context

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns the trace iD of the context.

func GetUserID

func GetUserID(ctx context.Context) (string, error)

GetUserID gets authenticated user id from context

func GetUserRole

func GetUserRole(ctx context.Context) (string, error)

GetUserRole gets user role from context

func IsAdmin

func IsAdmin(ctx context.Context) bool

IsAdmin returns true if the context has admin privileges

func IsBanned

func IsBanned(ctx context.Context) bool

IsBanned returns true if the context has banned flag

func IsGuest

func IsGuest(ctx context.Context) bool

IsGuest returns true if the context has guest

func ToAdminCtx

func ToAdminCtx(ctx context.Context) context.Context

ToAdminCtx upgrades the context with admin privileges

func ToBannedCtx

func ToBannedCtx(ctx context.Context) context.Context

ToBannedCtx upgrades the context with banned flag

func ToGuestCtx

func ToGuestCtx(ctx context.Context) context.Context

ToGuestCtx adds guest to context

func WithAppPlatform

func WithAppPlatform(ctx context.Context, platform string) context.Context

WithAppPlatform returns context containing application platform.

func WithAppVersion

func WithAppVersion(ctx context.Context, platform string) context.Context

WithAppVersion returns context containing application version.

func WithTraceID

func WithTraceID(ctx context.Context, traceID string) context.Context

WithTraceID returns context containing application platform.