larkauth

package
v3.2.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 3, 2024 License: MIT Imports: 3 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppAccessToken 

type AppAccessToken struct {
}

type AppTicket 

type AppTicket struct {
}

type CreateAppAccessTokenPathReqBodyBuilder 

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

func NewCreateAppAccessTokenPathReqBodyBuilder 

func NewCreateAppAccessTokenPathReqBodyBuilder() *CreateAppAccessTokenPathReqBodyBuilder

func (*CreateAppAccessTokenPathReqBodyBuilder) AppId 

func (builder *CreateAppAccessTokenPathReqBodyBuilder) AppId(appId string) *CreateAppAccessTokenPathReqBodyBuilder

应用唯一标识，创建应用后获得。有关app_id 的详细介绍。

示例值：cli_ddfgkk38emd38

func (*CreateAppAccessTokenPathReqBodyBuilder) AppSecret 

func (builder *CreateAppAccessTokenPathReqBodyBuilder) AppSecret(appSecret string) *CreateAppAccessTokenPathReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：clkfgkfdjes384kjdf9830d3k

func (*CreateAppAccessTokenPathReqBodyBuilder) AppTicket 

func (builder *CreateAppAccessTokenPathReqBodyBuilder) AppTicket(appTicket string) *CreateAppAccessTokenPathReqBodyBuilder

平台定时推送给应用的临时凭证，通过事件监听机制获得。

示例值：jdjlsd03jk34hj3kldjflcmkel

func (*CreateAppAccessTokenPathReqBodyBuilder) Build 

func (builder *CreateAppAccessTokenPathReqBodyBuilder) Build() (*CreateAppAccessTokenReqBody, error)

type CreateAppAccessTokenReq 

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

type CreateAppAccessTokenReqBody 

type CreateAppAccessTokenReqBody struct {
	AppId     *string `json:"app_id,omitempty"`     // 应用唯一标识，创建应用后获得。有关app_id 的详细介绍。
	AppSecret *string `json:"app_secret,omitempty"` // 应用秘钥，创建应用后获得。
	AppTicket *string `json:"app_ticket,omitempty"` // 平台定时推送给应用的临时凭证，通过事件监听机制获得。
}

type CreateAppAccessTokenReqBodyBuilder 

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

func NewCreateAppAccessTokenReqBodyBuilder 

func NewCreateAppAccessTokenReqBodyBuilder() *CreateAppAccessTokenReqBodyBuilder

func (*CreateAppAccessTokenReqBodyBuilder) AppId 

func (builder *CreateAppAccessTokenReqBodyBuilder) AppId(appId string) *CreateAppAccessTokenReqBodyBuilder

应用唯一标识，创建应用后获得。有关app_id 的详细介绍。

示例值：cli_ddfgkk38emd38

func (*CreateAppAccessTokenReqBodyBuilder) AppSecret 

func (builder *CreateAppAccessTokenReqBodyBuilder) AppSecret(appSecret string) *CreateAppAccessTokenReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：clkfgkfdjes384kjdf9830d3k

func (*CreateAppAccessTokenReqBodyBuilder) AppTicket 

func (builder *CreateAppAccessTokenReqBodyBuilder) AppTicket(appTicket string) *CreateAppAccessTokenReqBodyBuilder

平台定时推送给应用的临时凭证，通过事件监听机制获得。

示例值：jdjlsd03jk34hj3kldjflcmkel

func (*CreateAppAccessTokenReqBodyBuilder) Build 

func (builder *CreateAppAccessTokenReqBodyBuilder) Build() *CreateAppAccessTokenReqBody

type CreateAppAccessTokenReqBuilder 

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

func NewCreateAppAccessTokenReqBuilder 

func NewCreateAppAccessTokenReqBuilder() *CreateAppAccessTokenReqBuilder

func (*CreateAppAccessTokenReqBuilder) Body 

func (builder *CreateAppAccessTokenReqBuilder) Body(body *CreateAppAccessTokenReqBody) *CreateAppAccessTokenReqBuilder

func (*CreateAppAccessTokenReqBuilder) Build 

func (builder *CreateAppAccessTokenReqBuilder) Build() *CreateAppAccessTokenReq

type CreateAppAccessTokenResp 

type CreateAppAccessTokenResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*CreateAppAccessTokenResp) Success 

func (resp *CreateAppAccessTokenResp) Success() bool

type CreateTenantAccessTokenPathReqBodyBuilder 

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

func NewCreateTenantAccessTokenPathReqBodyBuilder 

func NewCreateTenantAccessTokenPathReqBodyBuilder() *CreateTenantAccessTokenPathReqBodyBuilder

func (*CreateTenantAccessTokenPathReqBodyBuilder) AppAccessToken 

func (builder *CreateTenantAccessTokenPathReqBodyBuilder) AppAccessToken(appAccessToken string) *CreateTenantAccessTokenPathReqBodyBuilder

应用访问凭证，通过商店应用获取 app_access_token接口获取。

示例值：a-32bd8551db2f081cbfd26293f27516390b9feb04

func (*CreateTenantAccessTokenPathReqBodyBuilder) Build 

func (builder *CreateTenantAccessTokenPathReqBodyBuilder) Build() (*CreateTenantAccessTokenReqBody, error)

func (*CreateTenantAccessTokenPathReqBodyBuilder) TenantKey 

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

租户在飞书上的唯一标识，也可以理解为企业标识可以通过如下方式获取： 业开通应用时，开放平台推送给应用，具体可参考【首次启用应用】事件； 用户登录到小程序、H5 应用或者浏览器应用时，在用户的身份信息中获取。

示例值：73658811060f175d

type CreateTenantAccessTokenReq 

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

type CreateTenantAccessTokenReqBody 

type CreateTenantAccessTokenReqBody struct {
	AppAccessToken *string `json:"app_access_token,omitempty"` // 应用访问凭证，通过商店应用获取 app_access_token接口获取。
	TenantKey      *string `json:"tenant_key,omitempty"`       // 租户在飞书上的唯一标识，也可以理解为企业标识可以通过如下方式获取：  业开通应用时，开放平台推送给应用，具体可参考【首次启用应用】事件； 用户登录到小程序、H5 应用或者浏览器应用时，在用户的身份信息中获取。
}

type CreateTenantAccessTokenReqBodyBuilder 

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

func NewCreateTenantAccessTokenReqBodyBuilder 

func NewCreateTenantAccessTokenReqBodyBuilder() *CreateTenantAccessTokenReqBodyBuilder

func (*CreateTenantAccessTokenReqBodyBuilder) AppAccessToken 

func (builder *CreateTenantAccessTokenReqBodyBuilder) AppAccessToken(appAccessToken string) *CreateTenantAccessTokenReqBodyBuilder

应用访问凭证，通过商店应用获取 app_access_token接口获取。

示例值：a-32bd8551db2f081cbfd26293f27516390b9feb04

func (*CreateTenantAccessTokenReqBodyBuilder) Build 

func (builder *CreateTenantAccessTokenReqBodyBuilder) Build() *CreateTenantAccessTokenReqBody

func (*CreateTenantAccessTokenReqBodyBuilder) TenantKey 

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

租户在飞书上的唯一标识，也可以理解为企业标识可以通过如下方式获取： 业开通应用时，开放平台推送给应用，具体可参考【首次启用应用】事件； 用户登录到小程序、H5 应用或者浏览器应用时，在用户的身份信息中获取。

示例值：73658811060f175d

type CreateTenantAccessTokenReqBuilder 

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

func NewCreateTenantAccessTokenReqBuilder 

func NewCreateTenantAccessTokenReqBuilder() *CreateTenantAccessTokenReqBuilder

func (*CreateTenantAccessTokenReqBuilder) Body 

func (builder *CreateTenantAccessTokenReqBuilder) Body(body *CreateTenantAccessTokenReqBody) *CreateTenantAccessTokenReqBuilder

func (*CreateTenantAccessTokenReqBuilder) Build 

func (builder *CreateTenantAccessTokenReqBuilder) Build() *CreateTenantAccessTokenReq

type CreateTenantAccessTokenResp 

type CreateTenantAccessTokenResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*CreateTenantAccessTokenResp) Success 

func (resp *CreateTenantAccessTokenResp) Success() bool

type DepartmentId added in v3.0.29 

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

type DepartmentIdBuilder added in v3.0.29 

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

func NewDepartmentIdBuilder added in v3.0.29 

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build added in v3.0.29 

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId added in v3.0.29 

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

示例值：

func (*DepartmentIdBuilder) OpenDepartmentId added in v3.0.29 

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

示例值：

type InternalAppAccessTokenPathReqBodyBuilder 

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

func NewInternalAppAccessTokenPathReqBodyBuilder 

func NewInternalAppAccessTokenPathReqBodyBuilder() *InternalAppAccessTokenPathReqBodyBuilder

func (*InternalAppAccessTokenPathReqBodyBuilder) AppId 

func (builder *InternalAppAccessTokenPathReqBodyBuilder) AppId(appId string) *InternalAppAccessTokenPathReqBodyBuilder

应用唯一标识，创建应用后获得。

示例值：cli_hsjeriogfkd93jf84

func (*InternalAppAccessTokenPathReqBodyBuilder) AppSecret 

func (builder *InternalAppAccessTokenPathReqBodyBuilder) AppSecret(appSecret string) *InternalAppAccessTokenPathReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：jdsfslkjdg8e73hdf9237enbd

func (*InternalAppAccessTokenPathReqBodyBuilder) Build 

func (builder *InternalAppAccessTokenPathReqBodyBuilder) Build() (*InternalAppAccessTokenReqBody, error)

type InternalAppAccessTokenReq 

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

type InternalAppAccessTokenReqBody 

type InternalAppAccessTokenReqBody struct {
	AppId     *string `json:"app_id,omitempty"`     // 应用唯一标识，创建应用后获得。
	AppSecret *string `json:"app_secret,omitempty"` // 应用秘钥，创建应用后获得。
}

type InternalAppAccessTokenReqBodyBuilder 

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

func NewInternalAppAccessTokenReqBodyBuilder 

func NewInternalAppAccessTokenReqBodyBuilder() *InternalAppAccessTokenReqBodyBuilder

func (*InternalAppAccessTokenReqBodyBuilder) AppId 

func (builder *InternalAppAccessTokenReqBodyBuilder) AppId(appId string) *InternalAppAccessTokenReqBodyBuilder

应用唯一标识，创建应用后获得。

示例值：cli_hsjeriogfkd93jf84

func (*InternalAppAccessTokenReqBodyBuilder) AppSecret 

func (builder *InternalAppAccessTokenReqBodyBuilder) AppSecret(appSecret string) *InternalAppAccessTokenReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：jdsfslkjdg8e73hdf9237enbd

func (*InternalAppAccessTokenReqBodyBuilder) Build 

func (builder *InternalAppAccessTokenReqBodyBuilder) Build() *InternalAppAccessTokenReqBody

type InternalAppAccessTokenReqBuilder 

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

func NewInternalAppAccessTokenReqBuilder 

func NewInternalAppAccessTokenReqBuilder() *InternalAppAccessTokenReqBuilder

func (*InternalAppAccessTokenReqBuilder) Body 

func (builder *InternalAppAccessTokenReqBuilder) Body(body *InternalAppAccessTokenReqBody) *InternalAppAccessTokenReqBuilder

func (*InternalAppAccessTokenReqBuilder) Build 

func (builder *InternalAppAccessTokenReqBuilder) Build() *InternalAppAccessTokenReq

type InternalAppAccessTokenResp 

type InternalAppAccessTokenResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*InternalAppAccessTokenResp) Success 

func (resp *InternalAppAccessTokenResp) Success() bool

type InternalTenantAccessTokenPathReqBodyBuilder 

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

func NewInternalTenantAccessTokenPathReqBodyBuilder 

func NewInternalTenantAccessTokenPathReqBodyBuilder() *InternalTenantAccessTokenPathReqBodyBuilder

func (*InternalTenantAccessTokenPathReqBodyBuilder) AppId 

func (builder *InternalTenantAccessTokenPathReqBodyBuilder) AppId(appId string) *InternalTenantAccessTokenPathReqBodyBuilder

应用唯一标识，创建应用后获得。

示例值：cli_slkdjalasdkjasd

func (*InternalTenantAccessTokenPathReqBodyBuilder) AppSecret 

func (builder *InternalTenantAccessTokenPathReqBodyBuilder) AppSecret(appSecret string) *InternalTenantAccessTokenPathReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：dskLLdkasdjlasdKK

func (*InternalTenantAccessTokenPathReqBodyBuilder) Build 

func (builder *InternalTenantAccessTokenPathReqBodyBuilder) Build() (*InternalTenantAccessTokenReqBody, error)

type InternalTenantAccessTokenReq 

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

type InternalTenantAccessTokenReqBody 

type InternalTenantAccessTokenReqBody struct {
	AppId     *string `json:"app_id,omitempty"`     // 应用唯一标识，创建应用后获得。
	AppSecret *string `json:"app_secret,omitempty"` // 应用秘钥，创建应用后获得。
}

type InternalTenantAccessTokenReqBodyBuilder 

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

func NewInternalTenantAccessTokenReqBodyBuilder 

func NewInternalTenantAccessTokenReqBodyBuilder() *InternalTenantAccessTokenReqBodyBuilder

func (*InternalTenantAccessTokenReqBodyBuilder) AppId 

func (builder *InternalTenantAccessTokenReqBodyBuilder) AppId(appId string) *InternalTenantAccessTokenReqBodyBuilder

应用唯一标识，创建应用后获得。

示例值：cli_slkdjalasdkjasd

func (*InternalTenantAccessTokenReqBodyBuilder) AppSecret 

func (builder *InternalTenantAccessTokenReqBodyBuilder) AppSecret(appSecret string) *InternalTenantAccessTokenReqBodyBuilder

应用秘钥，创建应用后获得。

示例值：dskLLdkasdjlasdKK

func (*InternalTenantAccessTokenReqBodyBuilder) Build 

func (builder *InternalTenantAccessTokenReqBodyBuilder) Build() *InternalTenantAccessTokenReqBody

type InternalTenantAccessTokenReqBuilder 

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

func NewInternalTenantAccessTokenReqBuilder 

func NewInternalTenantAccessTokenReqBuilder() *InternalTenantAccessTokenReqBuilder

func (*InternalTenantAccessTokenReqBuilder) Body 

func (builder *InternalTenantAccessTokenReqBuilder) Body(body *InternalTenantAccessTokenReqBody) *InternalTenantAccessTokenReqBuilder

func (*InternalTenantAccessTokenReqBuilder) Build 

func (builder *InternalTenantAccessTokenReqBuilder) Build() *InternalTenantAccessTokenReq

type InternalTenantAccessTokenResp 

type InternalTenantAccessTokenResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*InternalTenantAccessTokenResp) Success 

func (resp *InternalTenantAccessTokenResp) Success() bool

type ResendAppTicketPathReqBodyBuilder 

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

func NewResendAppTicketPathReqBodyBuilder 

func NewResendAppTicketPathReqBodyBuilder() *ResendAppTicketPathReqBodyBuilder

func (*ResendAppTicketPathReqBodyBuilder) AppId 

func (builder *ResendAppTicketPathReqBodyBuilder) AppId(appId string) *ResendAppTicketPathReqBodyBuilder

应用唯一标识，创建应用后获得

示例值：cli_slkdjalasdkjasd

func (*ResendAppTicketPathReqBodyBuilder) AppSecret 

func (builder *ResendAppTicketPathReqBodyBuilder) AppSecret(appSecret string) *ResendAppTicketPathReqBodyBuilder

应用秘钥，创建应用后获得

示例值：dskLLdkasdjlasdKK

func (*ResendAppTicketPathReqBodyBuilder) Build 

func (builder *ResendAppTicketPathReqBodyBuilder) Build() (*ResendAppTicketReqBody, error)

type ResendAppTicketReq 

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

type ResendAppTicketReqBody 

type ResendAppTicketReqBody struct {
	AppId     *string `json:"app_id,omitempty"`     // 应用唯一标识，创建应用后获得
	AppSecret *string `json:"app_secret,omitempty"` // 应用秘钥，创建应用后获得
}

type ResendAppTicketReqBodyBuilder 

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

func NewResendAppTicketReqBodyBuilder 

func NewResendAppTicketReqBodyBuilder() *ResendAppTicketReqBodyBuilder

func (*ResendAppTicketReqBodyBuilder) AppId 

func (builder *ResendAppTicketReqBodyBuilder) AppId(appId string) *ResendAppTicketReqBodyBuilder

应用唯一标识，创建应用后获得

示例值：cli_slkdjalasdkjasd

func (*ResendAppTicketReqBodyBuilder) AppSecret 

func (builder *ResendAppTicketReqBodyBuilder) AppSecret(appSecret string) *ResendAppTicketReqBodyBuilder

应用秘钥，创建应用后获得

示例值：dskLLdkasdjlasdKK

func (*ResendAppTicketReqBodyBuilder) Build 

func (builder *ResendAppTicketReqBodyBuilder) Build() *ResendAppTicketReqBody

type ResendAppTicketReqBuilder 

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

func NewResendAppTicketReqBuilder 

func NewResendAppTicketReqBuilder() *ResendAppTicketReqBuilder

func (*ResendAppTicketReqBuilder) Body 

func (builder *ResendAppTicketReqBuilder) Body(body *ResendAppTicketReqBody) *ResendAppTicketReqBuilder

func (*ResendAppTicketReqBuilder) Build 

func (builder *ResendAppTicketReqBuilder) Build() *ResendAppTicketReq

type ResendAppTicketResp 

type ResendAppTicketResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*ResendAppTicketResp) Success 

func (resp *ResendAppTicketResp) Success() bool

type RevokeTokenEvent added in v3.2.5 

type RevokeTokenEvent struct {
	RevokeTokenType *string `json:"revoke_token_type,omitempty"` // 撤销token的类型
	RevokeReason    *string `json:"revoke_reason,omitempty"`     // 撤销token的原因
	OpenId          *string `json:"open_id,omitempty"`           // 用户open_id
	UnionId         *string `json:"union_id,omitempty"`          // 用户union_id
	UserId          *string `json:"user_id,omitempty"`           // 租户内用户的唯一标识
}

type RevokeTokenEventBuilder added in v3.2.5 

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

func NewRevokeTokenEventBuilder added in v3.2.5 

func NewRevokeTokenEventBuilder() *RevokeTokenEventBuilder

func (*RevokeTokenEventBuilder) Build added in v3.2.5 

func (builder *RevokeTokenEventBuilder) Build() *RevokeTokenEvent

func (*RevokeTokenEventBuilder) OpenId added in v3.2.5 

func (builder *RevokeTokenEventBuilder) OpenId(openId string) *RevokeTokenEventBuilder

用户open_id

示例值：ou_c99c5f35d542efc7ee492afe11af19ef

func (*RevokeTokenEventBuilder) RevokeReason added in v3.2.5 

func (builder *RevokeTokenEventBuilder) RevokeReason(revokeReason string) *RevokeTokenEventBuilder

撤销token的原因

示例值：Revoked by security and risk control action.

func (*RevokeTokenEventBuilder) RevokeTokenType added in v3.2.5 

func (builder *RevokeTokenEventBuilder) RevokeTokenType(revokeTokenType string) *RevokeTokenEventBuilder

撤销token的类型

示例值：user_access_token refresh_token

func (*RevokeTokenEventBuilder) UnionId added in v3.2.5 

func (builder *RevokeTokenEventBuilder) UnionId(unionId string) *RevokeTokenEventBuilder

用户union_id

示例值：on_cad4860e7af114fb4ff6c5d496d1dd76

func (*RevokeTokenEventBuilder) UserId added in v3.2.5 

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

租户内用户的唯一标识

示例值：gg895344

type TenantAccessToken 

type TenantAccessToken struct {
}

type V3 added in v3.1.0 

type V3 struct {
	AppAccessToken    *appAccessToken    // app_access_token
	AppTicket         *appTicket         // app_ticket
	TenantAccessToken *tenantAccessToken // tenant_access_token
}

func New added in v3.1.0 

func New(config *larkcore.Config) *V3

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.