larkhuman_authentication

Documentation

Index

• Constants
• type CreateIdentityPathReqBodyBuilder
  • func NewCreateIdentityPathReqBodyBuilder() *CreateIdentityPathReqBodyBuilder
  • func (builder *CreateIdentityPathReqBodyBuilder) Build() (*CreateIdentityReqBody, error)
  • func (builder *CreateIdentityPathReqBodyBuilder) IdentityCode(identityCode string) *CreateIdentityPathReqBodyBuilder
  • func (builder *CreateIdentityPathReqBodyBuilder) IdentityName(identityName string) *CreateIdentityPathReqBodyBuilder
  • func (builder *CreateIdentityPathReqBodyBuilder) Mobile(mobile string) *CreateIdentityPathReqBodyBuilder
• type CreateIdentityReq
• type CreateIdentityReqBody
• type CreateIdentityReqBodyBuilder
  • func NewCreateIdentityReqBodyBuilder() *CreateIdentityReqBodyBuilder
  • func (builder *CreateIdentityReqBodyBuilder) Build() *CreateIdentityReqBody
  • func (builder *CreateIdentityReqBodyBuilder) IdentityCode(identityCode string) *CreateIdentityReqBodyBuilder
  • func (builder *CreateIdentityReqBodyBuilder) IdentityName(identityName string) *CreateIdentityReqBodyBuilder
  • func (builder *CreateIdentityReqBodyBuilder) Mobile(mobile string) *CreateIdentityReqBodyBuilder
• type CreateIdentityReqBuilder
  • func NewCreateIdentityReqBuilder() *CreateIdentityReqBuilder
  • func (builder *CreateIdentityReqBuilder) Body(body *CreateIdentityReqBody) *CreateIdentityReqBuilder
  • func (builder *CreateIdentityReqBuilder) Build() *CreateIdentityReq
  • func (builder *CreateIdentityReqBuilder) UserId(userId string) *CreateIdentityReqBuilder
  • func (builder *CreateIdentityReqBuilder) UserIdType(userIdType string) *CreateIdentityReqBuilder
• type CreateIdentityResp
  • func (resp *CreateIdentityResp) Success() bool
• type CreateIdentityRespData
• type HumanAuthenticationService
  • func NewService(config *larkcore.Config) *HumanAuthenticationService
• type Identity
• type IdentityBuilder
  • func NewIdentityBuilder() *IdentityBuilder
  • func (builder *IdentityBuilder) Build() *Identity
  • func (builder *IdentityBuilder) IdentityCode(identityCode string) *IdentityBuilder
  • func (builder *IdentityBuilder) IdentityName(identityName string) *IdentityBuilder
  • func (builder *IdentityBuilder) Mobile(mobile string) *IdentityBuilder

Constants

const (
	UserIdTypeOpenId  = "open_id"  // 以open_id来识别用户
	UserIdTypeUserId  = "user_id"  // 以user_id来识别用户
	UserIdTypeUnionId = "union_id" // 以union_id来识别用户
)

Types

type CreateIdentityPathReqBodyBuilder

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

func NewCreateIdentityPathReqBodyBuilder

func NewCreateIdentityPathReqBodyBuilder() *CreateIdentityPathReqBodyBuilder

func (*CreateIdentityPathReqBodyBuilder) Build

func (builder *CreateIdentityPathReqBodyBuilder) Build() (*CreateIdentityReqBody, error)

func (*CreateIdentityPathReqBodyBuilder) IdentityCode

func (builder *CreateIdentityPathReqBodyBuilder) IdentityCode(identityCode string) *CreateIdentityPathReqBodyBuilder

身份证号

示例值：4xxxxxxxx

func (*CreateIdentityPathReqBodyBuilder) IdentityName

func (builder *CreateIdentityPathReqBodyBuilder) IdentityName(identityName string) *CreateIdentityPathReqBodyBuilder

姓名

示例值：张三

func (*CreateIdentityPathReqBodyBuilder) Mobile

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

手机号

示例值：13xxxxxxx

type CreateIdentityReq

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

type CreateIdentityReqBody

type CreateIdentityReqBody struct {
	IdentityName *string `json:"identity_name,omitempty"` // 姓名
	IdentityCode *string `json:"identity_code,omitempty"` // 身份证号
	Mobile       *string `json:"mobile,omitempty"`        // 手机号
}

type CreateIdentityReqBodyBuilder

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

func NewCreateIdentityReqBodyBuilder

func NewCreateIdentityReqBodyBuilder() *CreateIdentityReqBodyBuilder

func (*CreateIdentityReqBodyBuilder) Build

func (builder *CreateIdentityReqBodyBuilder) Build() *CreateIdentityReqBody

func (*CreateIdentityReqBodyBuilder) IdentityCode

func (builder *CreateIdentityReqBodyBuilder) IdentityCode(identityCode string) *CreateIdentityReqBodyBuilder

身份证号

示例值：4xxxxxxxx

func (*CreateIdentityReqBodyBuilder) IdentityName

func (builder *CreateIdentityReqBodyBuilder) IdentityName(identityName string) *CreateIdentityReqBodyBuilder

姓名

示例值：张三

func (*CreateIdentityReqBodyBuilder) Mobile

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

手机号

示例值：13xxxxxxx

type CreateIdentityReqBuilder

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

func NewCreateIdentityReqBuilder

func NewCreateIdentityReqBuilder() *CreateIdentityReqBuilder

func (*CreateIdentityReqBuilder) Body

func (builder *CreateIdentityReqBuilder) Body(body *CreateIdentityReqBody) *CreateIdentityReqBuilder

该接口用于录入实名认证的身份信息，在唤起有源活体认证前，需要使用该接口进行实名认证。

func (*CreateIdentityReqBuilder) Build

func (builder *CreateIdentityReqBuilder) Build() *CreateIdentityReq

func (*CreateIdentityReqBuilder) UserId

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

用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：[如何获得 User ID、Open ID 和 Union ID？](/ssl:ttdoc/home/user-identity-introduction/how-to-get)）

示例值：ou_2eb5483cb377daa5054bc6f86e2089a5

func (*CreateIdentityReqBuilder) UserIdType

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

用户ID类型 open_id/user_id/union_id

示例值：

type CreateIdentityResp

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

func (*CreateIdentityResp) Success

func (resp *CreateIdentityResp) Success() bool

type CreateIdentityRespData

type CreateIdentityRespData struct {
	VerifyUid *string `json:"verify_uid,omitempty"` // 用户绑定实名身份的uid
}

type HumanAuthenticationService

type HumanAuthenticationService struct {
	Identity *identity // 身份
	// contains filtered or unexported fields
}

func NewService

func NewService(config *larkcore.Config) *HumanAuthenticationService

type Identity

type Identity struct {
	IdentityName *string `json:"identity_name,omitempty"` // user identity name
	IdentityCode *string `json:"identity_code,omitempty"` // user identity code
	Mobile       *string `json:"mobile,omitempty"`        // user mobile
}

type IdentityBuilder

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

func NewIdentityBuilder

func NewIdentityBuilder() *IdentityBuilder

func (*IdentityBuilder) Build

func (builder *IdentityBuilder) Build() *Identity

func (*IdentityBuilder) IdentityCode

func (builder *IdentityBuilder) IdentityCode(identityCode string) *IdentityBuilder

user identity code

示例值：

func (*IdentityBuilder) IdentityName

func (builder *IdentityBuilder) IdentityName(identityName string) *IdentityBuilder

user identity name

示例值：

func (*IdentityBuilder) Mobile

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

user mobile

示例值：