Documentation
¶
Index ¶
- func GetSessionExpiration() time.Duration
- func Register(config ...Config)
- type ChangePassword
- type ChangePasswordModule
- type ChangePasswordReq
- type ChangePasswordRsp
- type ChangePasswordService
- type Config
- type Group
- type GroupModule
- type GroupService
- type Heartbeat
- type HeartbeatModule
- type HeartbeatService
- type Login
- type LoginModule
- type LoginReq
- type LoginRsp
- type LoginService
- type Logout
- type LogoutModule
- type LogoutRsp
- type LogoutService
- type Me
- type MeModule
- type MeRsp
- type MeService
- type Offline
- type OfflineModule
- type OfflineReq
- type OfflineService
- type OnlineUser
- type OnlineUserModule
- type OnlineUserService
- type Session
- type Signup
- type SignupModule
- type SignupReq
- type SignupRsp
- type SignupService
- type Tenant
- type TenantModule
- type TenantService
- type Token
- type User
- type UserModule
- type UserService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSessionExpiration ¶ added in v0.10.5
GetSessionExpiration returns the configured session expiration time. If not configured, it returns the default value of 8 hours.
func Register ¶
func Register(config ...Config)
Register registers iam modules,
Models:
- ChangePassword
- Group
- Heartbeat
- Login
- Logout
- Offline
- Me
- OnlineUser
- Signup
- Tenant
- User
Routes:
- POST /api/iam/change-password
- POST /api/iam/groups
- DELETE /api/iam/groups/:id
- PUT /api/iam/groups/:id
- PATCH /api/iam/groups/:id
- GET /api/iam/groups
- GET /api/iam/groups/:id
- POST /api/heartbeat
- POST /api/login
- POST /api/logout
- POST /api/offline
- GET /api/me
- GET /api/online-users
- POST /api/signup
- POST /api/iam/tenants
- DELETE /api/iam/tenants/:id
- PUT /api/iam/tenants/:id
- PATCH /api/iam/tenants/:id
- GET /api/iam/tenants
- GET /api/iam/tenants/:id
- POST /api/iam/users
- DELETE /api/iam/users/:id
- PUT /api/iam/users/:id
- PATCH /api/iam/users/:id
- GET /api/iam/users
- GET /api/iam/users/:id
Middleware:
- IAMSession
Default disable Tenant module, use `EnableTenant` to enable it. Default session expiration time is 8 hours, use `SessionExpiration` to customize it.
NOTE: iam modules register must before "authz" modules register. because "authz" registered middleware "Authz" depend on iam modules registered middleware "IAMSession".
Types ¶
type ChangePassword ¶
type ChangePassword = modeliam.ChangePassword
type ChangePasswordModule ¶
type ChangePasswordModule struct{}
func (*ChangePasswordModule) Param ¶
func (*ChangePasswordModule) Param() string
func (*ChangePasswordModule) Pub ¶
func (*ChangePasswordModule) Pub() bool
func (*ChangePasswordModule) Route ¶
func (*ChangePasswordModule) Route() string
func (*ChangePasswordModule) Service ¶
func (*ChangePasswordModule) Service() types.Service[*ChangePassword, *ChangePasswordReq, *ChangePasswordRsp]
type ChangePasswordReq ¶
type ChangePasswordReq = modeliam.ChangePasswordReq
type ChangePasswordRsp ¶
type ChangePasswordRsp = modeliam.ChangePasswordRsp
type ChangePasswordService ¶
type ChangePasswordService = serviceiam.ChangePasswordService
type Config ¶
type Config struct {
EnableTenant bool // EnableTenant enables tenant module, default is false
DefaultUsers []*User // DefaultUsers are default users to create on registration
SessionExpiration time.Duration // SessionExpiration is the session expiration time, default is 8 hours
}
Config is the configuration for iam module.
type GroupModule ¶
type GroupModule struct{}
func (*GroupModule) Param ¶
func (*GroupModule) Param() string
func (*GroupModule) Pub ¶
func (*GroupModule) Pub() bool
func (*GroupModule) Route ¶
func (*GroupModule) Route() string
type GroupService ¶
type GroupService = serviceiam.GroupService
type HeartbeatModule ¶
type HeartbeatModule struct{}
func (*HeartbeatModule) Param ¶
func (*HeartbeatModule) Param() string
func (*HeartbeatModule) Pub ¶
func (*HeartbeatModule) Pub() bool
func (*HeartbeatModule) Route ¶
func (*HeartbeatModule) Route() string
type HeartbeatService ¶
type HeartbeatService = serviceiam.HeartbeatService
type LoginModule ¶
type LoginModule struct{}
func (*LoginModule) Param ¶
func (*LoginModule) Param() string
func (*LoginModule) Pub ¶
func (*LoginModule) Pub() bool
func (*LoginModule) Route ¶
func (*LoginModule) Route() string
type LoginService ¶
type LoginService = serviceiam.LoginService
type LogoutModule ¶
type LogoutModule struct{}
func (*LogoutModule) Param ¶
func (*LogoutModule) Param() string
func (*LogoutModule) Pub ¶
func (*LogoutModule) Pub() bool
func (*LogoutModule) Route ¶
func (*LogoutModule) Route() string
type LogoutService ¶
type LogoutService = serviceiam.LogoutService
type MeService ¶
type MeService = serviceiam.MeService
type OfflineModule ¶
type OfflineModule struct{}
func (*OfflineModule) Param ¶
func (*OfflineModule) Param() string
func (*OfflineModule) Pub ¶
func (*OfflineModule) Pub() bool
func (*OfflineModule) Route ¶
func (*OfflineModule) Route() string
func (*OfflineModule) Service ¶
func (*OfflineModule) Service() types.Service[*Offline, *OfflineReq, *Offline]
type OfflineReq ¶
type OfflineReq = modeliam.OfflineReq
type OfflineService ¶
type OfflineService = serviceiam.OfflineService
type OnlineUser ¶
type OnlineUser = modeliam.OnlineUser
type OnlineUserModule ¶
type OnlineUserModule struct{}
func (*OnlineUserModule) Param ¶
func (*OnlineUserModule) Param() string
func (*OnlineUserModule) Pub ¶
func (*OnlineUserModule) Pub() bool
func (*OnlineUserModule) Route ¶
func (*OnlineUserModule) Route() string
func (*OnlineUserModule) Service ¶
func (*OnlineUserModule) Service() types.Service[*OnlineUser, *OnlineUser, *OnlineUser]
type OnlineUserService ¶
type OnlineUserService = serviceiam.OnlineUserService
type SignupModule ¶
type SignupModule struct{}
func (*SignupModule) Param ¶
func (*SignupModule) Param() string
func (*SignupModule) Pub ¶
func (*SignupModule) Pub() bool
func (*SignupModule) Route ¶
func (*SignupModule) Route() string
type SignupService ¶
type SignupService = serviceiam.SignupService
type TenantModule ¶
type TenantModule struct{}
func (*TenantModule) Param ¶
func (*TenantModule) Param() string
func (*TenantModule) Pub ¶
func (*TenantModule) Pub() bool
func (*TenantModule) Route ¶
func (*TenantModule) Route() string
type TenantService ¶
type TenantService = serviceiam.TenantService
type UserModule ¶
type UserModule struct{}
func (*UserModule) Param ¶
func (*UserModule) Param() string
func (*UserModule) Pub ¶
func (*UserModule) Pub() bool
func (*UserModule) Route ¶
func (*UserModule) Route() string
type UserService ¶
type UserService = serviceiam.UserService
Source Files
Click to show internal directories.
Click to hide internal directories.