user

Documentation

Index

• Constants
• type Channel
• type QueryUserDetailReq
• type QueryUserDetailReqBody
• type QueryUserDetailReqBuilder
  • func NewQueryUserDetailReqBuilder() *QueryUserDetailReqBuilder
  • func (builder *QueryUserDetailReqBuilder) Build() *QueryUserDetailReq
  • func (builder *QueryUserDetailReqBuilder) Emails(emails []string) *QueryUserDetailReqBuilder
  • func (builder *QueryUserDetailReqBuilder) OutIDs(outIDs []string) *QueryUserDetailReqBuilder
  • func (builder *QueryUserDetailReqBuilder) TenantKey(tenantKey string) *QueryUserDetailReqBuilder
  • func (builder *QueryUserDetailReqBuilder) UserKeys(userKeys []string) *QueryUserDetailReqBuilder
  • func (builder *QueryUserDetailReqBuilder) Usernames(usernames []string) *QueryUserDetailReqBuilder
• type QueryUserDetailResp
• type RoleAssign
• type RoleOwner
• type SearchUserReq
• type SearchUserReqBody
• type SearchUserReqBuilder
  • func NewSearchUserReqBuilder() *SearchUserReqBuilder
  • func (builder *SearchUserReqBuilder) Build() *SearchUserReq
  • func (builder *SearchUserReqBuilder) ProjectKey(projectKey string) *SearchUserReqBuilder
  • func (builder *SearchUserReqBuilder) Query(query string) *SearchUserReqBuilder
• type SearchUserResp
• type UserBasicInfo
• type UserService
  • func NewService(config *core.Config) *UserService
  • func (a *UserService) QueryUserDetail(ctx context.Context, req *QueryUserDetailReq, ...) (*QueryUserDetailResp, error)
  • func (a *UserService) SearchUser(ctx context.Context, req *SearchUserReq, options ...core.RequestOptionFunc) (*SearchUserResp, error)

Constants

const APIPathQueryUserDetail = "/open_api/user/query"

const APIPathSearchUser = "/open_api/user/search"

Types

type Channel

type Channel struct {
	TenantName string `json:"tenant_name"`

	TenantGroupID int64 `json:"tenant_group_id"`
}

type QueryUserDetailReq

type QueryUserDetailReq struct {
	// contains filtered or unexported fields
}

type QueryUserDetailReqBody

type QueryUserDetailReqBody struct {
	UserKeys []string `json:"user_keys"`

	Usernames []string `json:"usernames"`

	OutIDs []string `json:"out_ids"`

	Emails []string `json:"emails"`

	TenantKey string `json:"tenant_key"`
}

type QueryUserDetailReqBuilder

type QueryUserDetailReqBuilder struct {
	// contains filtered or unexported fields
}

func NewQueryUserDetailReqBuilder

func NewQueryUserDetailReqBuilder() *QueryUserDetailReqBuilder

func (*QueryUserDetailReqBuilder) Build

func (builder *QueryUserDetailReqBuilder) Build() *QueryUserDetailReq

func (*QueryUserDetailReqBuilder) Emails

func (builder *QueryUserDetailReqBuilder) Emails(emails []string) *QueryUserDetailReqBuilder

func (*QueryUserDetailReqBuilder) OutIDs

func (builder *QueryUserDetailReqBuilder) OutIDs(outIDs []string) *QueryUserDetailReqBuilder

func (*QueryUserDetailReqBuilder) TenantKey

func (builder *QueryUserDetailReqBuilder) TenantKey(tenantKey string) *QueryUserDetailReqBuilder

func (*QueryUserDetailReqBuilder) UserKeys

func (builder *QueryUserDetailReqBuilder) UserKeys(userKeys []string) *QueryUserDetailReqBuilder

func (*QueryUserDetailReqBuilder) Usernames

func (builder *QueryUserDetailReqBuilder) Usernames(usernames []string) *QueryUserDetailReqBuilder

type QueryUserDetailResp

type QueryUserDetailResp struct {
	*core.APIResp `json:"-"`
	core.CodeError
	Data []*UserBasicInfo `json:"data"`
}

type RoleAssign

type RoleAssign struct {
	Role string `json:"role"`

	Name string `json:"name"`

	DefaultAppear int32 `json:"default_appear"`

	Deletable int32 `json:"deletable"`

	MemberAssign int32 `json:"member_assign"`

	Members []string `json:"members"`
}

type RoleOwner

type RoleOwner struct {
	Role string `json:"role"`

	Name string `json:"name"`

	Owners []string `json:"owners"`
}

type SearchUserReq

type SearchUserReq struct {
	// contains filtered or unexported fields
}

type SearchUserReqBody

type SearchUserReqBody struct {
	Query string `json:"query"`

	ProjectKey string `json:"project_key"`
}

type SearchUserReqBuilder

type SearchUserReqBuilder struct {
	// contains filtered or unexported fields
}

func NewSearchUserReqBuilder

func NewSearchUserReqBuilder() *SearchUserReqBuilder

func (*SearchUserReqBuilder) Build

func (builder *SearchUserReqBuilder) Build() *SearchUserReq

func (*SearchUserReqBuilder) ProjectKey

func (builder *SearchUserReqBuilder) ProjectKey(projectKey string) *SearchUserReqBuilder

func (*SearchUserReqBuilder) Query

func (builder *SearchUserReqBuilder) Query(query string) *SearchUserReqBuilder

type SearchUserResp

type SearchUserResp struct {
	*core.APIResp `json:"-"`
	core.CodeError
	Data []*UserBasicInfo `json:"data"`
}

type UserBasicInfo

type UserBasicInfo struct {
	UserID int64 `json:"user_id"`

	UserKey string `json:"user_key"`

	Username string `json:"username"`

	Email string `json:"email"`

	AvatarUrl string `json:"avatar_url"`

	NameCn string `json:"name_cn"`

	NameEn string `json:"name_en"`

	OutID string `json:"out_id"`

	Channels []*Channel `json:"channels"`

	Status string `json:"status"`
}

type UserService

type UserService struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(config *core.Config) *UserService

func (*UserService) QueryUserDetail

func (a *UserService) QueryUserDetail(ctx context.Context, req *QueryUserDetailReq, options ...core.RequestOptionFunc) (*QueryUserDetailResp, error)

获取用户详情

func (*UserService) SearchUser

func (a *UserService) SearchUser(ctx context.Context, req *SearchUserReq, options ...core.RequestOptionFunc) (*SearchUserResp, error)

模糊查询指定空间的用户列表