auth

Documentation

Index

• Constants
• func BuildOAuth2URL(o BuildOAuth2URLOptions) string
• func BuildProviderQRAuthURL(o BuildProviderQRAuthURLOptions) string
• func BuildQRAuthURL(o BuildQRAuthURLOptions) string
• func BuildSuiteInstallURL(o BuildSuiteInstallURLOption) string
• type BuildOAuth2URLOptions
• type BuildProviderQRAuthURLOptions
• type BuildQRAuthURLOptions
• type BuildSuiteInstallURLOption
• type ProviderQRAuthUserType

Constants

const (
	WecomOAuth2ScopeBase        = "snsapi_base"        // 静默授权，可获取成员的的基础信息（UserId与DeviceId）
	WecomOAuth2ScopeUserinfo    = "snsapi_userinfo"    // 静默授权，可获取成员的详细信息，但不包含手机、邮箱
	WecomOAuth2ScopePrivateInfo = "snsapi_privateinfo" // 手动授权，可获取成员的详细信息，包含手机、邮箱
)

Functions

func BuildOAuth2URL

func BuildOAuth2URL(o BuildOAuth2URLOptions) string

BuildOAuth2URL build oauth2 redirect url

https://work.weixin.qq.com/api/doc/90001/90143/91120

func BuildProviderQRAuthURL

func BuildProviderQRAuthURL(o BuildProviderQRAuthURLOptions) string

BuildProviderQRAuthURL 第三方扫码登陆

1. 管理员从企业微信管理端单点登录第三方 2. 管理员或成员在第三方网站发起登录授权

https://work.weixin.qq.com/api/doc/90001/90143/91124

func BuildQRAuthURL

func BuildQRAuthURL(o BuildQRAuthURLOptions) string

BuildQRAuthURL 企业自建应用扫码登陆

https://work.weixin.qq.com/api/doc/90000/90135/91019

func BuildSuiteInstallURL

func BuildSuiteInstallURL(o BuildSuiteInstallURLOption) string

BuildSuiteInstallURL build url for suite installation

see https://work.weixin.qq.com/api/doc/90001/90143/90597

Types

type BuildOAuth2URLOptions

type BuildOAuth2URLOptions struct {
	AppID        string `json:"appid,omitempty"` // 企业 CorpID 或 第三方 SuiteID
	RedirectURI  string `json:"redirect_uri,omitempty"`
	ResponseType string `json:"response_type,omitempty"`
	Scope        string `json:"scope,omitempty"` // 默认 snsapi_base, 自建使用 snsapi_userinfo 或 snsapi_privateinfo 需要 AgentID
	State        string `json:"state,omitempty"`
	AgentID      string `json:"agentid,omitempty"`
}

BuildOAuth2URLOptions options for BuildOAuth2URL

type BuildProviderQRAuthURLOptions

type BuildProviderQRAuthURLOptions struct {
	AppID       string                 `json:"appid,omitempty"` // 企业 CorpID 或 第三方 SuiteID
	RedirectURI string                 `json:"redirect_uri,omitempty"`
	UserType    ProviderQRAuthUserType `json:"usertype,omitempty"` // admin代表管理员登录（使用微信扫码）,member代表成员登录（使用企业微信扫码），默认为admin
	State       string                 `json:"state,omitempty"`
	Lang        string                 `json:"lang,omitempty"` // 自定义语言，支持zh、en；lang为空则从Headers读取Accept-Language，默认值为zh
}

BuildProviderQRAuthURLOptions options for BuildProviderQRAuthURL

type BuildQRAuthURLOptions

type BuildQRAuthURLOptions struct {
	AppID       string `json:"appid,omitempty"` // 企业 CorpID 或 第三方 SuiteID
	AgentID     string `json:"agentid,omitempty"`
	RedirectURI string `json:"redirect_uri,omitempty"`
	State       string `json:"state,omitempty"`
	Lang        string `json:"lang,omitempty"` // 自定义语言，支持zh、en；lang为空则从Headers读取Accept-Language，默认值为zh
}

BuildQRAuthURLOptions options for BuildQRAuthURL

type BuildSuiteInstallURLOption

type BuildSuiteInstallURLOption struct {
	SuiteID     string `json:"suite_id,omitempty"`
	PreAuthCode string `json:"pre_auth_code,omitempty"`
	RedirectURI string `json:"redirect_uri,omitempty"`
	State       string `json:"state,omitempty"` // a-zA-Z0-9 的参数值（不超过128个字节），用于第三方自行校验session，防止跨域攻击。
}

type ProviderQRAuthUserType

type ProviderQRAuthUserType = string

const (
	ProviderQRAuthUserTypeAdmin  ProviderQRAuthUserType = "admin"
	ProviderQRAuthUserTypeMember ProviderQRAuthUserType = "member"
)