requestctx

package

v2.0.7 Latest Latest Go to latest Published: May 16, 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/FangcunMount/iam

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func BusinessOrgID(c *gin.Context) (uint64, bool)
func Claims(c *gin.Context) (any, bool)
func LoginIdentityID(c *gin.Context) (meta.ID, bool)
func OrgIDOrDefault(c *gin.Context) uint64deprecated
func RequestIDString(c *gin.Context) (string, bool)
func RequiredTenantID(c *gin.Context) (string, error)
func RequiredUserID(c *gin.Context) (meta.ID, error)
func SetClaims(c *gin.Context, claims any)
func SetLoginIdentityID(c *gin.Context, id meta.ID)
func SetOrgID(c *gin.Context, orgID uint64)
func SetTenantID(c *gin.Context, tenantID string)
func SetTokenID(c *gin.Context, tokenID string)
func SetUserID(c *gin.Context, id meta.ID)
func TenantIDOrDefault(c *gin.Context) string
func TenantIDString(c *gin.Context) (string, bool)
func TokenIDString(c *gin.Context) (string, bool)
func UserID(c *gin.Context) (meta.ID, bool)

Constants ¶

View Source

const (
	KeyClaims          = "claims"
	KeyUserID          = "user_id"
	KeyLoginIdentityID = "login_identity_id"
	KeyTenantID        = "tenant_id"
	KeyOrgID           = "org_id"
	KeyTokenID         = "token_id"
	KeyRequestID       = "request_id"
)

Variables ¶

This section is empty.

Functions ¶

func BusinessOrgID ¶ added in v2.0.7

func BusinessOrgID(c *gin.Context) (uint64, bool)

BusinessOrgID 读取 token 透传的业务组织 ID。 IAM 不定义默认 org；无 claim 时返回 ok=false。

func Claims ¶

func Claims(c *gin.Context) (any, bool)

func LoginIdentityID ¶ added in v2.0.5

func LoginIdentityID(c *gin.Context) (meta.ID, bool)

LoginIdentityID 从请求上下文中获取登录身份ID

func OrgIDOrDefault deprecated added in v2.0.7

func OrgIDOrDefault(c *gin.Context) uint64

OrgIDOrDefault 已废弃默认 org 语义，仅为兼容保留；无 claim 时返回 0。

Deprecated: 使用 BusinessOrgID；不要依赖 IAM 提供默认组织 ID。

func RequestIDString ¶

func RequestIDString(c *gin.Context) (string, bool)

func RequiredTenantID ¶

func RequiredTenantID(c *gin.Context) (string, error)

RequiredTenantID 从请求上下文中获取租户ID，如果不存在或无效则返回错误

func RequiredUserID ¶

func RequiredUserID(c *gin.Context) (meta.ID, error)

RequiredUserID 从请求上下文中获取用户ID，如果不存在或无效则返回错误

func SetClaims ¶

func SetClaims(c *gin.Context, claims any)

func SetLoginIdentityID ¶ added in v2.0.5

func SetLoginIdentityID(c *gin.Context, id meta.ID)

SetLoginIdentityID 设置登录身份ID到请求上下文中

func SetOrgID ¶ added in v2.0.7

func SetOrgID(c *gin.Context, orgID uint64)

SetOrgID 将 JWT 透传的业务 org_id 写入请求上下文（非 IAM 领域字段）。

func SetTenantID ¶

func SetTenantID(c *gin.Context, tenantID string)

SetTenantID 设置租户ID到请求上下文中

func SetTokenID ¶

func SetTokenID(c *gin.Context, tokenID string)

SetTokenID 设置Token ID到请求上下文中

func SetUserID ¶

func SetUserID(c *gin.Context, id meta.ID)

SetUserID 设置用户ID到请求上下文中

func TenantIDOrDefault ¶

func TenantIDOrDefault(c *gin.Context) string

TenantIDOrDefault 从请求上下文中获取租户ID，如果不存在则返回默认租户ID

func TenantIDString ¶

func TenantIDString(c *gin.Context) (string, bool)

TenantIDString 从请求上下文中获取租户ID字符串，如果不存在或不是字符串则返回空字符串和false

func TokenIDString ¶

func TokenIDString(c *gin.Context) (string, bool)

TokenIDString 从请求上下文中获取Token ID字符串

func UserID ¶

func UserID(c *gin.Context) (meta.ID, bool)

UserID 从请求上下文中获取用户ID

Types ¶

This section is empty.

Source Files ¶

View all Source files

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