context

package

v0.9.0 Latest Latest Go to latest Published: Aug 18, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

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

Repository

github.com/openkcm/cmk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BusinessToInternalContext(ctx context.Context, role constants.InternalRole) (context.Context, error)
func CreateTenantContext(ctx context.Context, tenantSchema string) context.Context
func ExtractBusinessUserData(ctx context.Context) (*auth.ClientData, error)
func ExtractBusinessUserDataAuthContext(ctx context.Context) (map[string]string, error)
func ExtractBusinessUserDataAuthContextField(ctx context.Context, field string) (string, error)
func ExtractBusinessUserDataGroups(ctx context.Context) ([]string, error)
func ExtractBusinessUserDataGroupsString(ctx context.Context) ([]string, error)
func ExtractBusinessUserDataIdentifier(ctx context.Context) (string, error)
func ExtractBusinessUserDataIssuer(ctx context.Context) (string, error)
func ExtractInternalRole(ctx context.Context) (constants.InternalRole, error)
func ExtractTenantID(ctx context.Context) (string, error)
func ExtractUserIdentifier(ctx context.Context) (string, error)
func ExtractUserType(ctx context.Context) (string, error)
func GetRequestID(ctx context.Context) (string, error)
func InjectBusinessUserData(ctx context.Context, businessUserData *auth.ClientData, ...) context.Context
func InjectInternalUserData(ctx context.Context, role constants.InternalRole) (context.Context, error)
func InjectRequestID(ctx context.Context, requestID string) context.Context
func New(ctx context.Context, opts ...Opt) context.Context
type Opt
- func WithInjectBusinessUserData(businessUserData *auth.ClientData, authContextFields []string) Opt
- func WithTenant(tenantSchema string) Opt

Constants ¶

View Source

const TenantKey = key("tenant")

Variables ¶

View Source

var (
	ErrTenantInvalid                      = errors.New("invalid tenant or tenant not found")
	ErrExtractTenantID                    = errors.New("could not extract tenant ID from context")
	ErrGetRequestID                       = errors.New("no requestID found in context")
	ErrExtractBusinessUserData            = errors.New("could not extract business data from context")
	ErrExtractBusinessUserDataAuthContext = errors.New("could not extract field from business data auth context")
	ErrExtractUserType                    = errors.New("could not extract user type from context")
	ErrInvalidUserType                    = errors.New("invalid user type")
)

Functions ¶

func BusinessToInternalContext ¶ added in v0.9.0

func BusinessToInternalContext(
	ctx context.Context,
	role constants.InternalRole,
) (context.Context, error)

func CreateTenantContext ¶

func CreateTenantContext(ctx context.Context, tenantSchema string) context.Context

func ExtractBusinessUserData ¶ added in v0.9.0

func ExtractBusinessUserData(ctx context.Context) (*auth.ClientData, error)

func ExtractBusinessUserDataAuthContext ¶ added in v0.9.0

func ExtractBusinessUserDataAuthContext(ctx context.Context) (map[string]string, error)

func ExtractBusinessUserDataAuthContextField ¶ added in v0.9.0

func ExtractBusinessUserDataAuthContextField(ctx context.Context, field string) (string, error)

func ExtractBusinessUserDataGroups ¶ added in v0.9.0

func ExtractBusinessUserDataGroups(ctx context.Context) ([]string, error)

func ExtractBusinessUserDataGroupsString ¶ added in v0.9.0

func ExtractBusinessUserDataGroupsString(ctx context.Context) ([]string, error)

func ExtractBusinessUserDataIdentifier ¶ added in v0.9.0

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

func ExtractBusinessUserDataIssuer ¶ added in v0.9.0

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

func ExtractInternalRole ¶ added in v0.9.0

func ExtractInternalRole(ctx context.Context) (constants.InternalRole, error)

func ExtractTenantID ¶

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

func ExtractUserIdentifier ¶ added in v0.9.0

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

ExtractUserIdentifier returns a string identifier for the caller regardless of user type. For business users this is the IAM identifier; for internal users it is the role string.

func ExtractUserType ¶ added in v0.9.0

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

func GetRequestID ¶

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

func InjectBusinessUserData ¶ added in v0.9.0

func InjectBusinessUserData(
	ctx context.Context,
	businessUserData *auth.ClientData,
	authContextFields []string,
) context.Context

func InjectInternalUserData ¶ added in v0.9.0

func InjectInternalUserData(
	ctx context.Context,
	role constants.InternalRole,
) (context.Context, error)

func InjectRequestID ¶

func InjectRequestID(ctx context.Context, requestID string) context.Context

func New ¶ added in v0.4.0

func New(ctx context.Context, opts ...Opt) context.Context

Types ¶

type Opt ¶ added in v0.4.0

type Opt func(ctx context.Context) context.Context

func WithInjectBusinessUserData ¶ added in v0.9.0

func WithInjectBusinessUserData(businessUserData *auth.ClientData, authContextFields []string) Opt

func WithTenant ¶ added in v0.4.0

func WithTenant(tenantSchema string) Opt

Source Files ¶

View all Source files

context.go

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