larkpassport

Documentation

Index

• Constants
• type Credentials
• type CredentialsBuilder
  • func NewCredentialsBuilder() *CredentialsBuilder
  • func (builder *CredentialsBuilder) Build() *Credentials
  • func (builder *CredentialsBuilder) Email(email string) *CredentialsBuilder
  • func (builder *CredentialsBuilder) Mobile(mobile string) *CredentialsBuilder
  • func (builder *CredentialsBuilder) UserId(userId string) *CredentialsBuilder
• type DepartmentId
• type DepartmentIdBuilder
  • func NewDepartmentIdBuilder() *DepartmentIdBuilder
  • func (builder *DepartmentIdBuilder) Build() *DepartmentId
  • func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder
  • func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder
• type IdpCredential
• type IdpCredentialId
• type IdpCredentialIdBuilder
  • func NewIdpCredentialIdBuilder() *IdpCredentialIdBuilder
  • func (builder *IdpCredentialIdBuilder) Build() *IdpCredentialId
  • func (builder *IdpCredentialIdBuilder) IdpCredentialId(idpCredentialId string) *IdpCredentialIdBuilder
• type MaskSession
• type MaskSessionBuilder
  • func NewMaskSessionBuilder() *MaskSessionBuilder
  • func (builder *MaskSessionBuilder) Build() *MaskSession
  • func (builder *MaskSessionBuilder) CreateTime(createTime string) *MaskSessionBuilder
  • func (builder *MaskSessionBuilder) TerminalType(terminalType int) *MaskSessionBuilder
  • func (builder *MaskSessionBuilder) UserId(userId string) *MaskSessionBuilder
• type PassportService
  • func NewService(config *larkcore.Config) *PassportService
• type QuerySessionPathReqBodyBuilder
  • func NewQuerySessionPathReqBodyBuilder() *QuerySessionPathReqBodyBuilder
  • func (builder *QuerySessionPathReqBodyBuilder) Build() (*QuerySessionReqBody, error)
  • func (builder *QuerySessionPathReqBodyBuilder) UserIds(userIds []string) *QuerySessionPathReqBodyBuilder
• type QuerySessionReq
• type QuerySessionReqBody
• type QuerySessionReqBodyBuilder
  • func NewQuerySessionReqBodyBuilder() *QuerySessionReqBodyBuilder
  • func (builder *QuerySessionReqBodyBuilder) Build() *QuerySessionReqBody
  • func (builder *QuerySessionReqBodyBuilder) UserIds(userIds []string) *QuerySessionReqBodyBuilder
• type QuerySessionReqBuilder
  • func NewQuerySessionReqBuilder() *QuerySessionReqBuilder
  • func (builder *QuerySessionReqBuilder) Body(body *QuerySessionReqBody) *QuerySessionReqBuilder
  • func (builder *QuerySessionReqBuilder) Build() *QuerySessionReq
  • func (builder *QuerySessionReqBuilder) UserIdType(userIdType string) *QuerySessionReqBuilder
• type QuerySessionResp
  • func (resp *QuerySessionResp) Success() bool
• type QuerySessionRespData

Constants

const (
	UserIdTypeOpenId  = "open_id"  // 用户的 open id
	UserIdTypeUnionId = "union_id" // 用户的 union id
	UserIdTypeUserId  = "user_id"  // 用户的 user id
)

Types

type Credentials

type Credentials struct {
	Email  *string `json:"email,omitempty"`   // 邮箱
	Mobile *string `json:"mobile,omitempty"`  // 手机号
	UserId *string `json:"user_id,omitempty"` // 用户id
}

type CredentialsBuilder

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

func NewCredentialsBuilder

func NewCredentialsBuilder() *CredentialsBuilder

func (*CredentialsBuilder) Build

func (builder *CredentialsBuilder) Build() *Credentials

func (*CredentialsBuilder) Email

func (builder *CredentialsBuilder) Email(email string) *CredentialsBuilder

邮箱

示例值：q*****@qq.com

func (*CredentialsBuilder) Mobile

func (builder *CredentialsBuilder) Mobile(mobile string) *CredentialsBuilder

手机号

示例值：186*****01

func (*CredentialsBuilder) UserId

func (builder *CredentialsBuilder) UserId(userId string) *CredentialsBuilder

用户id

示例值：

type DepartmentId

type DepartmentId struct {
	DepartmentId     *string `json:"department_id,omitempty"`      //
	OpenDepartmentId *string `json:"open_department_id,omitempty"` //
}

type DepartmentIdBuilder

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

func NewDepartmentIdBuilder

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId

func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder

示例值：

func (*DepartmentIdBuilder) OpenDepartmentId

func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder

示例值：

type IdpCredential

type IdpCredential struct {
}

type IdpCredentialId

type IdpCredentialId struct {
	IdpCredentialId *string `json:"idp_credential_id,omitempty"` // idp侧租户唯一标识
}

type IdpCredentialIdBuilder

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

func NewIdpCredentialIdBuilder

func NewIdpCredentialIdBuilder() *IdpCredentialIdBuilder

func (*IdpCredentialIdBuilder) Build

func (builder *IdpCredentialIdBuilder) Build() *IdpCredentialId

func (*IdpCredentialIdBuilder) IdpCredentialId

func (builder *IdpCredentialIdBuilder) IdpCredentialId(idpCredentialId string) *IdpCredentialIdBuilder

idp侧租户唯一标识

示例值：

type MaskSession

type MaskSession struct {
	CreateTime   *string `json:"create_time,omitempty"`   // 创建时间
	TerminalType *int    `json:"terminal_type,omitempty"` // 客户端类型
	UserId       *string `json:"user_id,omitempty"`       // 用户ID
}

type MaskSessionBuilder

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

func NewMaskSessionBuilder

func NewMaskSessionBuilder() *MaskSessionBuilder

func (*MaskSessionBuilder) Build

func (builder *MaskSessionBuilder) Build() *MaskSession

func (*MaskSessionBuilder) CreateTime

func (builder *MaskSessionBuilder) CreateTime(createTime string) *MaskSessionBuilder

创建时间

示例值：

func (*MaskSessionBuilder) TerminalType

func (builder *MaskSessionBuilder) TerminalType(terminalType int) *MaskSessionBuilder

客户端类型

示例值：

func (*MaskSessionBuilder) UserId

func (builder *MaskSessionBuilder) UserId(userId string) *MaskSessionBuilder

用户ID

示例值：

type PassportService

type PassportService struct {
	Session *session // 登录态
	// contains filtered or unexported fields
}

func NewService

func NewService(config *larkcore.Config) *PassportService

type QuerySessionPathReqBodyBuilder

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

func NewQuerySessionPathReqBodyBuilder

func NewQuerySessionPathReqBodyBuilder() *QuerySessionPathReqBodyBuilder

func (*QuerySessionPathReqBodyBuilder) Build

func (builder *QuerySessionPathReqBodyBuilder) Build() (*QuerySessionReqBody, error)

func (*QuerySessionPathReqBodyBuilder) UserIds

func (builder *QuerySessionPathReqBodyBuilder) UserIds(userIds []string) *QuerySessionPathReqBodyBuilder

用户 ID

示例值：["47f621ff"]

type QuerySessionReq

type QuerySessionReq struct {
	Body *QuerySessionReqBody `body:""`
	// contains filtered or unexported fields
}

type QuerySessionReqBody

type QuerySessionReqBody struct {
	UserIds []string `json:"user_ids,omitempty"` // 用户 ID
}

type QuerySessionReqBodyBuilder

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

func NewQuerySessionReqBodyBuilder

func NewQuerySessionReqBodyBuilder() *QuerySessionReqBodyBuilder

func (*QuerySessionReqBodyBuilder) Build

func (builder *QuerySessionReqBodyBuilder) Build() *QuerySessionReqBody

func (*QuerySessionReqBodyBuilder) UserIds

func (builder *QuerySessionReqBodyBuilder) UserIds(userIds []string) *QuerySessionReqBodyBuilder

用户 ID

示例值：["47f621ff"]

type QuerySessionReqBuilder

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

func NewQuerySessionReqBuilder

func NewQuerySessionReqBuilder() *QuerySessionReqBuilder

func (*QuerySessionReqBuilder) Body

func (builder *QuerySessionReqBuilder) Body(body *QuerySessionReqBody) *QuerySessionReqBuilder

该接口用于查询用户的登录信息

func (*QuerySessionReqBuilder) Build

func (builder *QuerySessionReqBuilder) Build() *QuerySessionReq

func (*QuerySessionReqBuilder) UserIdType

func (builder *QuerySessionReqBuilder) UserIdType(userIdType string) *QuerySessionReqBuilder

示例值：open_id

type QuerySessionResp

type QuerySessionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *QuerySessionRespData `json:"data"` // 业务数据
}

func (*QuerySessionResp) Success

func (resp *QuerySessionResp) Success() bool

type QuerySessionRespData

type QuerySessionRespData struct {
	MaskSessions []*MaskSession `json:"mask_sessions,omitempty"` // 用户登录信息
}