casdoorsdk

package
v0.43.1 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const MfaRecoveryCodesSession = "mfa_recovery_codes"

Variables

View Source 
var (
	CasdoorApplication  = "app-built-in"
	CasdoorOrganization = "built-in"
)
View Source 
var (
	TestCasdoorEndpoint     = "https://demo.casdoor.com"
	TestClientId            = "294b09fbc17f95daf2fe"
	TestClientSecret        = "dd8982f7046ccba1bbd7851d5c1ece4e52bf039d"
	TestCasdoorOrganization = "casbin"
	TestCasdoorApplication  = "app-vue-python-example"
)
View Source 
var TestJwtPublicKey = `` /* 1784-byte string literal not displayed */

Functions

func AddAdapter 

func AddAdapter(adapter *Adapter) (bool, error)

func AddApplication 

func AddApplication(application *Application) (bool, error)

func AddCert 

func AddCert(cert *Cert) (bool, error)

func AddEnforcer 

func AddEnforcer(enforcer *Enforcer) (bool, error)

func AddGroup 

func AddGroup(group *Group) (bool, error)

func AddModel 

func AddModel(model *Model) (bool, error)

func AddOrganization 

func AddOrganization(organization *Organization) (bool, error)

func AddPayment 

func AddPayment(payment *Payment) (bool, error)

func AddPermission 

func AddPermission(permission *Permission) (bool, error)

func AddPlan 

func AddPlan(plan *Plan) (bool, error)

func AddPolicy added in v0.43.1 

func AddPolicy(enforcer *Enforcer, policy *CasbinRule) (bool, error)

func AddPricing 

func AddPricing(pricing *Pricing) (bool, error)

func AddProduct 

func AddProduct(product *Product) (bool, error)

func AddProvider 

func AddProvider(provider *Provider) (bool, error)

func AddRecord 

func AddRecord(record *Record) (bool, error)

func AddRole 

func AddRole(role *Role) (bool, error)

func AddSession 

func AddSession(session *Session) (bool, error)

func AddSubscription 

func AddSubscription(subscription *Subscription) (bool, error)

func AddSyncer 

func AddSyncer(syncer *Syncer) (bool, error)

func AddToken 

func AddToken(token *Token) (bool, error)

func AddTransaction added in v0.43.1 

func AddTransaction(transaction *Transaction) (bool, error)

func AddUser 

func AddUser(user *User) (bool, error)

func AddWebhook 

func AddWebhook(webhook *Webhook) (bool, error)

func BatchEnforce 

func BatchEnforce(permissionId, modelId, resourceId string, casbinRequests []CasbinRequest) ([][]bool, error)

func CheckUserPassword 

func CheckUserPassword(user *User) (bool, error)

func DeleteAdapter 

func DeleteAdapter(adapter *Adapter) (bool, error)

func DeleteApplication 

func DeleteApplication(application *Application) (bool, error)

func DeleteCert 

func DeleteCert(cert *Cert) (bool, error)

func DeleteEnforcer 

func DeleteEnforcer(enforcer *Enforcer) (bool, error)

func DeleteGroup 

func DeleteGroup(group *Group) (bool, error)

func DeleteModel 

func DeleteModel(model *Model) (bool, error)

func DeleteOrganization 

func DeleteOrganization(organization *Organization) (bool, error)

func DeletePayment 

func DeletePayment(payment *Payment) (bool, error)

func DeletePermission 

func DeletePermission(permission *Permission) (bool, error)

func DeletePlan 

func DeletePlan(plan *Plan) (bool, error)

func DeletePricing 

func DeletePricing(pricing *Pricing) (bool, error)

func DeleteProduct 

func DeleteProduct(product *Product) (bool, error)

func DeleteProvider 

func DeleteProvider(provider *Provider) (bool, error)

func DeleteResource 

func DeleteResource(resource *Resource) (bool, error)

func DeleteRole 

func DeleteRole(role *Role) (bool, error)

func DeleteSession 

func DeleteSession(session *Session) (bool, error)

func DeleteSubscription 

func DeleteSubscription(subscription *Subscription) (bool, error)

func DeleteSyncer 

func DeleteSyncer(syncer *Syncer) (bool, error)

func DeleteToken 

func DeleteToken(token *Token) (bool, error)

func DeleteTransaction added in v0.43.1 

func DeleteTransaction(transaction *Transaction) (bool, error)

func DeleteUser 

func DeleteUser(user *User) (bool, error)

func DeleteWebhook 

func DeleteWebhook(webhook *Webhook) (bool, error)

func DoGetBytes 

func DoGetBytes(url string) ([]byte, error)

DoGetBytes is a general function to get response data in bytes from param url through HTTP Get method.

func DoGetBytesRaw 

func DoGetBytesRaw(url string) ([]byte, error)

DoGetBytesRaw is a general function to get response from param url through HTTP Get method.

func DoPostBytesRaw 

func DoPostBytesRaw(url string, contentType string, body io.Reader) ([]byte, error)

DoPostBytesRaw is a general function to post a request from url, body through HTTP Post method.

func Enforce 

func Enforce(permissionId, modelId, resourceId string, casbinRequest CasbinRequest) (bool, error)

func GetCurrentTime 

func GetCurrentTime() string

func GetMyProfileUrl 

func GetMyProfileUrl(accessToken string) string

func GetOAuthToken 

func GetOAuthToken(code string, state string) (*oauth2.Token, error)

func GetSigninUrl 

func GetSigninUrl(redirectUri string) string

func GetSignupUrl 

func GetSignupUrl(enablePassword bool, redirectUri string) string

func GetUrl 

func GetUrl(action string, queryMap map[string]string) string

func GetUserCount 

func GetUserCount(isOnline string) (int, error)

func GetUserProfileUrl 

func GetUserProfileUrl(userName string, accessToken string) string

func InitConfig 

func InitConfig(endpoint string, clientId string, clientSecret string, certificate string, organizationName string, applicationName string)

func InvoicePayment 

func InvoicePayment(payment *Payment) (bool, error)

func Login added in v0.43.1 

func Login(form AuthForm) (string, error)

func NotifyPayment 

func NotifyPayment(payment *Payment) (bool, error)

func RefreshOAuthToken 

func RefreshOAuthToken(refreshToken string) (*oauth2.Token, error)

func RemovePolicy added in v0.43.1 

func RemovePolicy(enforcer *Enforcer, policy *CasbinRule) (bool, error)

func SendEmail 

func SendEmail(title string, content string, sender string, receivers ...string) error

func SendSms 

func SendSms(content string, receivers ...string) error

func SendVerificationCode added in v0.43.1 

func SendVerificationCode(form VerificationForm) error

func SetHttpClient 

func SetHttpClient(httpClient HttpClient)

SetHttpClient sets custom http Client.

func SetPassword 

func SetPassword(owner, name, oldPassword, newPassword string) (bool, error)

note: oldPassword is not required, if you don't need, just pass a empty string

func UpdateAdapter 

func UpdateAdapter(adapter *Adapter) (bool, error)

func UpdateApplication 

func UpdateApplication(name string, application *Application) (bool, error)

func UpdateCert 

func UpdateCert(cert *Cert) (bool, error)

func UpdateEnforcer 

func UpdateEnforcer(enforcer *Enforcer) (bool, error)

func UpdateGroup 

func UpdateGroup(group *Group) (bool, error)

func UpdateModel 

func UpdateModel(model *Model) (bool, error)

func UpdateOrganization 

func UpdateOrganization(name string, organization *Organization) (bool, error)

func UpdatePayment 

func UpdatePayment(payment *Payment) (bool, error)

func UpdatePermission 

func UpdatePermission(permission *Permission) (bool, error)

func UpdatePermissionForColumns 

func UpdatePermissionForColumns(permission *Permission, columns []string) (bool, error)

func UpdatePlan 

func UpdatePlan(plan *Plan) (bool, error)

func UpdatePolicy added in v0.43.1 

func UpdatePolicy(enforcer *Enforcer, oldpolicy *CasbinRule, newpolicy *CasbinRule) (bool, error)

func UpdatePricing 

func UpdatePricing(pricing *Pricing) (bool, error)

func UpdateProduct 

func UpdateProduct(product *Product) (bool, error)

func UpdateProvider 

func UpdateProvider(provider *Provider) (bool, error)

func UpdateRole 

func UpdateRole(role *Role) (bool, error)

func UpdateRoleForColumns 

func UpdateRoleForColumns(role *Role, columns []string) (bool, error)

func UpdateSession 

func UpdateSession(session *Session) (bool, error)

func UpdateSessionForColumns 

func UpdateSessionForColumns(session *Session, columns []string) (bool, error)

func UpdateSubscription 

func UpdateSubscription(subscription *Subscription) (bool, error)

func UpdateSyncer 

func UpdateSyncer(syncer *Syncer) (bool, error)

func UpdateToken 

func UpdateToken(token *Token) (bool, error)

func UpdateTokenForColumns 

func UpdateTokenForColumns(token *Token, columns []string) (bool, error)

func UpdateTransaction added in v0.43.1 

func UpdateTransaction(transaction *Transaction) (bool, error)

func UpdateUser 

func UpdateUser(user *User) (bool, error)

func UpdateUserById 

func UpdateUserById(id string, user *User) (bool, error)

func UpdateUserForColumns 

func UpdateUserForColumns(user *User, columns []string) (bool, error)

func UpdateWebhook 

func UpdateWebhook(webhook *Webhook) (bool, error)

func UploadResource 

func UploadResource(user string, tag string, parent string, fullFilePath string, fileBytes []byte) (string, string, error)

func UploadResourceEx 

func UploadResourceEx(user string, tag string, parent string, fullFilePath string, fileBytes []byte, createdTime string, description string) (string, string, error)

Types

type AccountItem 

type AccountItem struct {
	Name       string `json:"name"`
	Visible    bool   `json:"visible"`
	ViewRule   string `json:"viewRule"`
	ModifyRule string `json:"modifyRule"`
}

type Adapter 

type Adapter struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	Type            string `xorm:"varchar(100)" json:"type"`
	DatabaseType    string `xorm:"varchar(100)" json:"databaseType"`
	Host            string `xorm:"varchar(100)" json:"host"`
	Port            int    `json:"port"`
	User            string `xorm:"varchar(100)" json:"user"`
	Password        string `xorm:"varchar(100)" json:"password"`
	Database        string `xorm:"varchar(100)" json:"database"`
	Table           string `xorm:"varchar(100)" json:"table"`
	TableNamePrefix string `xorm:"varchar(100)" json:"tableNamePrefix"`

	IsEnabled bool `json:"isEnabled"`
}

func GetAdapter 

func GetAdapter(name string) (*Adapter, error)

func GetAdapters 

func GetAdapters() ([]*Adapter, error)

func GetPaginationAdapters 

func GetPaginationAdapters(p int, pageSize int, queryMap map[string]string) ([]*Adapter, int, error)

type Application 

type Application struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	DisplayName         string          `xorm:"varchar(100)" json:"displayName"`
	HomepageUrl         string          `xorm:"varchar(100)" json:"homepageUrl"`
	Description         string          `xorm:"varchar(100)" json:"description"`
	Organization        string          `xorm:"varchar(100)" json:"organization"`
	Cert                string          `xorm:"varchar(100)" json:"cert"`
	EnablePassword      bool            `json:"enablePassword"`
	EnableSignUp        bool            `json:"enableSignUp"`
	EnableSigninSession bool            `json:"enableSigninSession"`
	EnableAutoSignin    bool            `json:"enableAutoSignin"`
	EnableCodeSignin    bool            `json:"enableCodeSignin"`
	EnableSamlCompress  bool            `json:"enableSamlCompress"`
	EnableSamlC14n10    bool            `json:"enableSamlC14n10"`
	EnableWebAuthn      bool            `json:"enableWebAuthn"`
	EnableLinkWithEmail bool            `json:"enableLinkWithEmail"`
	OrgChoiceMode       string          `json:"orgChoiceMode"`
	SamlReplyUrl        string          `xorm:"varchar(100)" json:"samlReplyUrl"`
	Providers           []*ProviderItem `xorm:"mediumtext" json:"providers"`
	SigninMethods       []*SigninMethod `xorm:"varchar(2000)" json:"signinMethods"`
	SignupItems         []*SignupItem   `xorm:"varchar(2000)" json:"signupItems"`
	GrantTypes          []string        `xorm:"varchar(1000)" json:"grantTypes"`
	OrganizationObj     *Organization   `xorm:"-" json:"organizationObj"`
	CertPublicKey       string          `xorm:"-" json:"certPublicKey"`
	Tags                []string        `xorm:"mediumtext" json:"tags"`
	InvitationCodes     []string        `xorm:"varchar(200)" json:"invitationCodes"`
	SamlAttributes      []*SamlItem     `xorm:"varchar(1000)" json:"samlAttributes"`

	ClientId             string     `xorm:"varchar(100)" json:"clientId"`
	ClientSecret         string     `xorm:"varchar(100)" json:"clientSecret"`
	RedirectUris         []string   `xorm:"varchar(1000)" json:"redirectUris"`
	TokenFormat          string     `xorm:"varchar(100)" json:"tokenFormat"`
	TokenFields          []string   `xorm:"varchar(1000)" json:"tokenFields"`
	ExpireInHours        int        `json:"expireInHours"`
	RefreshExpireInHours int        `json:"refreshExpireInHours"`
	SignupUrl            string     `xorm:"varchar(200)" json:"signupUrl"`
	SigninUrl            string     `xorm:"varchar(200)" json:"signinUrl"`
	ForgetUrl            string     `xorm:"varchar(200)" json:"forgetUrl"`
	AffiliationUrl       string     `xorm:"varchar(100)" json:"affiliationUrl"`
	TermsOfUse           string     `xorm:"varchar(100)" json:"termsOfUse"`
	SignupHtml           string     `xorm:"mediumtext" json:"signupHtml"`
	SigninHtml           string     `xorm:"mediumtext" json:"signinHtml"`
	ThemeData            *ThemeData `xorm:"json" json:"themeData"`
	FormCss              string     `xorm:"text" json:"formCss"`
	FormCssMobile        string     `xorm:"text" json:"formCssMobile"`
	FormOffset           int        `json:"formOffset"`
	FormSideHtml         string     `xorm:"mediumtext" json:"formSideHtml"`
	FormBackgroundUrl    string     `xorm:"varchar(200)" json:"formBackgroundUrl"`

	FailedSigninLimit      int `json:"failedSigninLimit"`
	FailedSigninfrozenTime int `json:"failedSigninfrozenTime"`
}

func GetApplication 

func GetApplication(name string) (*Application, error)

func GetApplications 

func GetApplications() ([]*Application, error)

func GetOrganizationApplications 

func GetOrganizationApplications() ([]*Application, error)

type AuthConfig 

type AuthConfig struct {
	Endpoint         string
	ClientId         string
	ClientSecret     string
	Certificate      string
	OrganizationName string
	ApplicationName  string
}

AuthConfig is the core configuration. The first step to use this SDK is to use the InitConfig function to initialize the global authConfig.

type AuthForm added in v0.43.1 

type AuthForm struct {
	Type         string `json:"type"`
	SigninMethod string `json:"signinMethod"`

	Organization   string `json:"organization"`
	Username       string `json:"username"`
	Password       string `json:"password"`
	Name           string `json:"name"`
	FirstName      string `json:"firstName"`
	LastName       string `json:"lastName"`
	Email          string `json:"email"`
	Phone          string `json:"phone"`
	Affiliation    string `json:"affiliation"`
	IdCard         string `json:"idCard"`
	Region         string `json:"region"`
	InvitationCode string `json:"invitationCode"`

	Application string `json:"application"`
	ClientId    string `json:"clientId"`
	Provider    string `json:"provider"`
	Code        string `json:"code"`
	State       string `json:"state"`
	RedirectUri string `json:"redirectUri"`
	Method      string `json:"method"`

	EmailCode   string `json:"emailCode"`
	PhoneCode   string `json:"phoneCode"`
	CountryCode string `json:"countryCode"`

	AutoSignin bool `json:"autoSignin"`

	RelayState   string `json:"relayState"`
	SamlRequest  string `json:"samlRequest"`
	SamlResponse string `json:"samlResponse"`

	CaptchaType  string `json:"captchaType"`
	CaptchaToken string `json:"captchaToken"`
	ClientSecret string `json:"clientSecret"`

	MfaType      string `json:"mfaType"`
	Passcode     string `json:"passcode"`
	RecoveryCode string `json:"recoveryCode"`

	Plan    string `json:"plan"`
	Pricing string `json:"pricing"`

	FaceId []float64 `json:"faceId"`
}

type CasbinRequest 

type CasbinRequest = []interface{}

type CasbinRule added in v0.43.1 

type CasbinRule struct {
	Id    int64  `xorm:"pk autoincr"`
	Ptype string `xorm:"varchar(100) index not null default ''"`
	V0    string `xorm:"varchar(100) index not null default ''"`
	V1    string `xorm:"varchar(100) index not null default ''"`
	V2    string `xorm:"varchar(100) index not null default ''"`
	V3    string `xorm:"varchar(100) index not null default ''"`
	V4    string `xorm:"varchar(100) index not null default ''"`
	V5    string `xorm:"varchar(100) index not null default ''"`
	// contains filtered or unexported fields
}

func GetPolicies added in v0.43.1 

func GetPolicies(enforcerName string, adapterId string) ([]*CasbinRule, error)

type Cert 

type Cert struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	DisplayName     string `xorm:"varchar(100)" json:"displayName"`
	Scope           string `xorm:"varchar(100)" json:"scope"`
	Type            string `xorm:"varchar(100)" json:"type"`
	CryptoAlgorithm string `xorm:"varchar(100)" json:"cryptoAlgorithm"`
	BitSize         int    `json:"bitSize"`
	ExpireInYears   int    `json:"expireInYears"`

	Certificate            string `xorm:"mediumtext" json:"certificate"`
	PrivateKey             string `xorm:"mediumtext" json:"privateKey"`
	AuthorityPublicKey     string `xorm:"mediumtext" json:"authorityPublicKey"`
	AuthorityRootPublicKey string `xorm:"mediumtext" json:"authorityRootPublicKey"`
}

Cert has the same definition as https://github.com/casdoor/casdoor/blob/master/object/cert.go#L24

func GetCert 

func GetCert(name string) (*Cert, error)

func GetCerts 

func GetCerts() ([]*Cert, error)

func GetGlobalCerts 

func GetGlobalCerts() ([]*Cert, error)

type Claims 

type Claims struct {
	User
	AccessToken string `json:"accessToken"`
	jwt.RegisteredClaims
	TokenType        string `json:"tokenType"`
	RefreshTokenType string `json:"TokenType"`
}

func ParseJwtToken 

func ParseJwtToken(token string) (*Claims, error)

func (Claims) IsRefreshToken added in v0.43.1 

func (c Claims) IsRefreshToken() bool

IsRefreshToken returns true if the token is a refresh token

type Client 

type Client struct {
	AuthConfig
}

func NewClient 

func NewClient(endpoint string, clientId string, clientSecret string, certificate string, organizationName string, applicationName string) *Client

func NewClientWithConf 

func NewClientWithConf(config *AuthConfig) *Client

func (*Client) AddAdapter 

func (c *Client) AddAdapter(adapter *Adapter) (bool, error)

func (*Client) AddApplication 

func (c *Client) AddApplication(application *Application) (bool, error)

func (*Client) AddCert 

func (c *Client) AddCert(cert *Cert) (bool, error)

func (*Client) AddEnforcer 

func (c *Client) AddEnforcer(enforcer *Enforcer) (bool, error)

func (*Client) AddGroup 

func (c *Client) AddGroup(group *Group) (bool, error)

func (*Client) AddModel 

func (c *Client) AddModel(model *Model) (bool, error)

func (*Client) AddOrganization 

func (c *Client) AddOrganization(organization *Organization) (bool, error)

func (*Client) AddPayment 

func (c *Client) AddPayment(payment *Payment) (bool, error)

func (*Client) AddPermission 

func (c *Client) AddPermission(permission *Permission) (bool, error)

func (*Client) AddPlan 

func (c *Client) AddPlan(plan *Plan) (bool, error)

func (*Client) AddPolicy added in v0.43.1 

func (c *Client) AddPolicy(enforcer *Enforcer, policy *CasbinRule) (bool, error)

func (*Client) AddPricing 

func (c *Client) AddPricing(pricing *Pricing) (bool, error)

func (*Client) AddProduct 

func (c *Client) AddProduct(product *Product) (bool, error)

func (*Client) AddProvider 

func (c *Client) AddProvider(provider *Provider) (bool, error)

func (*Client) AddRecord 

func (c *Client) AddRecord(record *Record) (bool, error)

func (*Client) AddRole 

func (c *Client) AddRole(role *Role) (bool, error)

func (*Client) AddSession 

func (c *Client) AddSession(session *Session) (bool, error)

func (*Client) AddSubscription 

func (c *Client) AddSubscription(subscription *Subscription) (bool, error)

func (*Client) AddSyncer 

func (c *Client) AddSyncer(syncer *Syncer) (bool, error)

func (*Client) AddToken 

func (c *Client) AddToken(token *Token) (bool, error)

func (*Client) AddTransaction added in v0.43.1 

func (c *Client) AddTransaction(transaction *Transaction) (bool, error)

func (*Client) AddUser 

func (c *Client) AddUser(user *User) (bool, error)

func (*Client) AddWebhook 

func (c *Client) AddWebhook(webhook *Webhook) (bool, error)

func (*Client) BatchEnforce 

func (c *Client) BatchEnforce(permissionId, modelId, resourceId string, casbinRequests []CasbinRequest) ([][]bool, error)

func (*Client) BuyProduct 

func (c *Client) BuyProduct(name string, providerName string) (*Product, error)

func (*Client) CheckUserPassword 

func (c *Client) CheckUserPassword(user *User) (bool, error)

func (*Client) DeleteAdapter 

func (c *Client) DeleteAdapter(adapter *Adapter) (bool, error)

func (*Client) DeleteApplication 

func (c *Client) DeleteApplication(application *Application) (bool, error)

func (*Client) DeleteCert 

func (c *Client) DeleteCert(cert *Cert) (bool, error)

func (*Client) DeleteEnforcer 

func (c *Client) DeleteEnforcer(enforcer *Enforcer) (bool, error)

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(group *Group) (bool, error)

func (*Client) DeleteModel 

func (c *Client) DeleteModel(model *Model) (bool, error)

func (*Client) DeleteOrganization 

func (c *Client) DeleteOrganization(organization *Organization) (bool, error)

func (*Client) DeletePayment 

func (c *Client) DeletePayment(payment *Payment) (bool, error)

func (*Client) DeletePermission 

func (c *Client) DeletePermission(permission *Permission) (bool, error)

func (*Client) DeletePlan 

func (c *Client) DeletePlan(plan *Plan) (bool, error)

func (*Client) DeletePricing 

func (c *Client) DeletePricing(pricing *Pricing) (bool, error)

func (*Client) DeleteProduct 

func (c *Client) DeleteProduct(product *Product) (bool, error)

func (*Client) DeleteProvider 

func (c *Client) DeleteProvider(provider *Provider) (bool, error)

func (*Client) DeleteResource 

func (c *Client) DeleteResource(resource *Resource) (bool, error)

func (*Client) DeleteRole 

func (c *Client) DeleteRole(role *Role) (bool, error)

func (*Client) DeleteSession 

func (c *Client) DeleteSession(session *Session) (bool, error)

func (*Client) DeleteSubscription 

func (c *Client) DeleteSubscription(subscription *Subscription) (bool, error)

func (*Client) DeleteSyncer 

func (c *Client) DeleteSyncer(syncer *Syncer) (bool, error)

func (*Client) DeleteToken 

func (c *Client) DeleteToken(token *Token) (bool, error)

func (*Client) DeleteTransaction added in v0.43.1 

func (c *Client) DeleteTransaction(transaction *Transaction) (bool, error)

func (*Client) DeleteUser 

func (c *Client) DeleteUser(user *User) (bool, error)

func (*Client) DeleteWebhook 

func (c *Client) DeleteWebhook(webhook *Webhook) (bool, error)

func (*Client) DoGetBytes 

func (c *Client) DoGetBytes(url string) ([]byte, error)

DoGetBytes is a general function to get response data in bytes from param url through HTTP Get method.

func (*Client) DoGetBytesRaw 

func (c *Client) DoGetBytesRaw(url string) ([]byte, error)

DoGetBytesRaw is a general function to get response from param url through HTTP Get method.

func (*Client) DoGetResponse 

func (c *Client) DoGetResponse(url string) (*Response, error)

DoGetResponse is a general function to get response from param url through HTTP Get method.

func (*Client) DoPost 

func (c *Client) DoPost(action string, queryMap map[string]string, postBytes []byte, isForm, isFile bool) (*Response, error)

func (*Client) DoPostBytesRaw 

func (c *Client) DoPostBytesRaw(url string, contentType string, body io.Reader) ([]byte, error)

DoPostBytesRaw is a general function to post a request from url, body through HTTP Post method.

func (*Client) DoPostJson added in v0.43.1 

func (c *Client) DoPostJson(url string, postBytes []byte) (*Response, error)

func (*Client) Enforce 

func (c *Client) Enforce(permissionId, modelId, resourceId string, casbinRequest CasbinRequest) (bool, error)

func (*Client) GetAdapter 

func (c *Client) GetAdapter(name string) (*Adapter, error)

func (*Client) GetAdapters 

func (c *Client) GetAdapters() ([]*Adapter, error)

func (*Client) GetApplication 

func (c *Client) GetApplication(name string) (*Application, error)

func (*Client) GetApplications 

func (c *Client) GetApplications() ([]*Application, error)

func (*Client) GetCert 

func (c *Client) GetCert(name string) (*Cert, error)

func (*Client) GetCerts 

func (c *Client) GetCerts() ([]*Cert, error)

func (*Client) GetEnforcer 

func (c *Client) GetEnforcer(name string) (*Enforcer, error)

func (*Client) GetEnforcers 

func (c *Client) GetEnforcers() ([]*Enforcer, error)

func (*Client) GetGlobalCerts 

func (c *Client) GetGlobalCerts() ([]*Cert, error)

func (*Client) GetGlobalUsers 

func (c *Client) GetGlobalUsers() ([]*User, error)

func (*Client) GetGroup 

func (c *Client) GetGroup(name string) (*Group, error)

func (*Client) GetGroups 

func (c *Client) GetGroups() ([]*Group, error)

func (*Client) GetId 

func (c *Client) GetId(name string) string

func (*Client) GetModel 

func (c *Client) GetModel(name string) (*Model, error)

func (*Client) GetModels 

func (c *Client) GetModels() ([]*Model, error)

func (*Client) GetMyProfileUrl 

func (c *Client) GetMyProfileUrl(accessToken string) string

func (*Client) GetOAuthToken 

func (c *Client) GetOAuthToken(code string, state string) (*oauth2.Token, error)

GetOAuthToken gets the pivotal and necessary secret to interact with the Casdoor server

func (*Client) GetOrganization 

func (c *Client) GetOrganization(name string) (*Organization, error)

func (*Client) GetOrganizationApplications 

func (c *Client) GetOrganizationApplications() ([]*Application, error)

func (*Client) GetOrganizationNames 

func (c *Client) GetOrganizationNames() ([]*Organization, error)

func (*Client) GetOrganizations 

func (c *Client) GetOrganizations() ([]*Organization, error)

func (*Client) GetPaginationAdapters 

func (c *Client) GetPaginationAdapters(p int, pageSize int, queryMap map[string]string) ([]*Adapter, int, error)

func (*Client) GetPaginationEnforcers 

func (c *Client) GetPaginationEnforcers(p int, pageSize int, queryMap map[string]string) ([]*Enforcer, int, error)

func (*Client) GetPaginationGroups 

func (c *Client) GetPaginationGroups(p int, pageSize int, queryMap map[string]string) ([]*Group, int, error)

func (*Client) GetPaginationModels 

func (c *Client) GetPaginationModels(p int, pageSize int, queryMap map[string]string) ([]*Model, int, error)

func (*Client) GetPaginationOrganizations added in v0.34.2 

func (c *Client) GetPaginationOrganizations(p int, pageSize int, queryMap map[string]string) ([]*Organization, int, error)

func (*Client) GetPaginationPayments 

func (c *Client) GetPaginationPayments(p int, pageSize int, queryMap map[string]string) ([]*Payment, int, error)

func (*Client) GetPaginationPermissions 

func (c *Client) GetPaginationPermissions(p int, pageSize int, queryMap map[string]string) ([]*Permission, int, error)

func (*Client) GetPaginationPlans 

func (c *Client) GetPaginationPlans(p int, pageSize int, queryMap map[string]string) ([]*Plan, int, error)

func (*Client) GetPaginationPricings 

func (c *Client) GetPaginationPricings(p int, pageSize int, queryMap map[string]string) ([]*Pricing, int, error)

func (*Client) GetPaginationProducts 

func (c *Client) GetPaginationProducts(p int, pageSize int, queryMap map[string]string) ([]*Product, int, error)

func (*Client) GetPaginationProviders 

func (c *Client) GetPaginationProviders(p int, pageSize int, queryMap map[string]string) ([]*Provider, int, error)

func (*Client) GetPaginationRecords 

func (c *Client) GetPaginationRecords(p int, pageSize int, queryMap map[string]string) ([]*Record, int, error)

func (*Client) GetPaginationResources 

func (c *Client) GetPaginationResources(owner, user, field, value string, pageSize, page int, sortField, sortOrder string) ([]*Resource, error)

func (*Client) GetPaginationRoles 

func (c *Client) GetPaginationRoles(p int, pageSize int, queryMap map[string]string) ([]*Role, int, error)

func (*Client) GetPaginationSessions 

func (c *Client) GetPaginationSessions(p int, pageSize int, queryMap map[string]string) ([]*Session, int, error)

func (*Client) GetPaginationSubscriptions 

func (c *Client) GetPaginationSubscriptions(p int, pageSize int, queryMap map[string]string) ([]*Subscription, int, error)

func (*Client) GetPaginationSyncers 

func (c *Client) GetPaginationSyncers(p int, pageSize int, queryMap map[string]string) ([]*Syncer, int, error)

func (*Client) GetPaginationTokens 

func (c *Client) GetPaginationTokens(p int, pageSize int, queryMap map[string]string) ([]*Token, int, error)

func (*Client) GetPaginationTransactions added in v0.43.1 

func (c *Client) GetPaginationTransactions(p int, pageSize int, queryMap map[string]string) ([]*Transaction, int, error)

func (*Client) GetPaginationUsers 

func (c *Client) GetPaginationUsers(p int, pageSize int, queryMap map[string]string) ([]*User, int, error)

func (*Client) GetPaginationWebhooks 

func (c *Client) GetPaginationWebhooks(p int, pageSize int, queryMap map[string]string) ([]*Webhook, int, error)

func (*Client) GetPayment 

func (c *Client) GetPayment(name string) (*Payment, error)

func (*Client) GetPayments 

func (c *Client) GetPayments() ([]*Payment, error)

func (*Client) GetPermission 

func (c *Client) GetPermission(name string) (*Permission, error)

func (*Client) GetPermissions 

func (c *Client) GetPermissions() ([]*Permission, error)

func (*Client) GetPermissionsByRole 

func (c *Client) GetPermissionsByRole(name string) ([]*Permission, error)

func (*Client) GetPlan 

func (c *Client) GetPlan(name string) (*Plan, error)

func (*Client) GetPlans 

func (c *Client) GetPlans() ([]*Plan, error)

func (*Client) GetPolicies added in v0.43.1 

func (c *Client) GetPolicies(enforcerName string, adapterId string) ([]*CasbinRule, error)

func (*Client) GetPricing 

func (c *Client) GetPricing(name string) (*Pricing, error)

func (*Client) GetPricings 

func (c *Client) GetPricings() ([]*Pricing, error)

func (*Client) GetProduct 

func (c *Client) GetProduct(name string) (*Product, error)

func (*Client) GetProducts 

func (c *Client) GetProducts() ([]*Product, error)

func (*Client) GetProvider 

func (c *Client) GetProvider(name string) (*Provider, error)

func (*Client) GetProviders 

func (c *Client) GetProviders() ([]*Provider, error)

func (*Client) GetRecord 

func (c *Client) GetRecord(name string) (*Record, error)

func (*Client) GetRecords 

func (c *Client) GetRecords() ([]*Record, error)

func (*Client) GetResource 

func (c *Client) GetResource(id string) (*Resource, error)

func (*Client) GetResourceEx 

func (c *Client) GetResourceEx(owner, name string) (*Resource, error)

func (*Client) GetResources 

func (c *Client) GetResources(owner, user, field, value, sortField, sortOrder string) ([]*Resource, error)

func (*Client) GetRole 

func (c *Client) GetRole(name string) (*Role, error)

func (*Client) GetRoles 

func (c *Client) GetRoles() ([]*Role, error)

func (*Client) GetSession 

func (c *Client) GetSession(name string, application string) (*Session, error)

func (*Client) GetSessions 

func (c *Client) GetSessions() ([]*Session, error)

func (*Client) GetSigninUrl 

func (c *Client) GetSigninUrl(redirectUri string) string

func (*Client) GetSignupUrl 

func (c *Client) GetSignupUrl(enablePassword bool, redirectUri string) string

func (*Client) GetSortedUsers 

func (c *Client) GetSortedUsers(sorter string, limit int) ([]*User, error)

func (*Client) GetSubscription 

func (c *Client) GetSubscription(name string) (*Subscription, error)

func (*Client) GetSubscriptions 

func (c *Client) GetSubscriptions() ([]*Subscription, error)

func (*Client) GetSyncer 

func (c *Client) GetSyncer(name string) (*Syncer, error)

func (*Client) GetSyncers 

func (c *Client) GetSyncers() ([]*Syncer, error)

func (*Client) GetToken 

func (c *Client) GetToken(name string) (*Token, error)

func (*Client) GetTokens 

func (c *Client) GetTokens() ([]*Token, error)

func (*Client) GetTransaction added in v0.43.1 

func (c *Client) GetTransaction(name string) (*Transaction, error)

func (*Client) GetTransactions added in v0.43.1 

func (c *Client) GetTransactions() ([]*Transaction, error)

func (*Client) GetUrl 

func (c *Client) GetUrl(action string, queryMap map[string]string) string

func (*Client) GetUser 

func (c *Client) GetUser(name string) (*User, error)

func (*Client) GetUserByEmail 

func (c *Client) GetUserByEmail(email string) (*User, error)

func (*Client) GetUserByPhone 

func (c *Client) GetUserByPhone(phone string) (*User, error)

func (*Client) GetUserByUserId 

func (c *Client) GetUserByUserId(userId string) (*User, error)

func (*Client) GetUserCount 

func (c *Client) GetUserCount(isOnline string) (int, error)

func (*Client) GetUserPayments 

func (c *Client) GetUserPayments(userName string) ([]*Payment, error)

func (*Client) GetUserProfileUrl 

func (c *Client) GetUserProfileUrl(userName string, accessToken string) string

func (*Client) GetUserTransactions added in v0.43.1 

func (c *Client) GetUserTransactions(userName string) ([]*Transaction, error)

func (*Client) GetUsers 

func (c *Client) GetUsers() ([]*User, error)

func (*Client) GetWebhook 

func (c *Client) GetWebhook(name string) (*Webhook, error)

func (*Client) GetWebhooks 

func (c *Client) GetWebhooks() ([]*Webhook, error)

func (*Client) IntrospectToken added in v0.43.1 

func (c *Client) IntrospectToken(token, tokenTypeHint string) (result *IntroSpectTokenResult, err error)

func (*Client) InvoicePayment 

func (c *Client) InvoicePayment(payment *Payment) (bool, error)

func (*Client) Login added in v0.43.1 

func (c *Client) Login(form AuthForm) (string, error)

func (*Client) NotifyPayment 

func (c *Client) NotifyPayment(payment *Payment) (bool, error)

func (*Client) ParseJwtToken 

func (c *Client) ParseJwtToken(token string) (*Claims, error)

func (*Client) RefreshOAuthToken 

func (c *Client) RefreshOAuthToken(refreshToken string) (*oauth2.Token, error)

RefreshOAuthToken refreshes the OAuth token

func (*Client) RemovePolicy added in v0.43.1 

func (c *Client) RemovePolicy(enforcer *Enforcer, policy *CasbinRule) (bool, error)

func (*Client) SendEmail 

func (c *Client) SendEmail(title string, content string, sender string, receivers ...string) error

func (*Client) SendSms 

func (c *Client) SendSms(content string, receivers ...string) error

func (*Client) SendVerificationCode added in v0.43.1 

func (c *Client) SendVerificationCode(form VerificationForm) error

func (*Client) SetPassword 

func (c *Client) SetPassword(owner, name, oldPassword, newPassword string) (bool, error)

note: oldPassword is not required, if you don't need, just pass a empty string

func (*Client) UpdateAdapter 

func (c *Client) UpdateAdapter(adapter *Adapter) (bool, error)

func (*Client) UpdateApplication 

func (c *Client) UpdateApplication(name string, application *Application) (bool, error)

func (*Client) UpdateCert 

func (c *Client) UpdateCert(cert *Cert) (bool, error)

func (*Client) UpdateEnforcer 

func (c *Client) UpdateEnforcer(enforcer *Enforcer) (bool, error)

func (*Client) UpdateGroup 

func (c *Client) UpdateGroup(group *Group) (bool, error)

func (*Client) UpdateModel 

func (c *Client) UpdateModel(model *Model) (bool, error)

func (*Client) UpdateOrganization 

func (c *Client) UpdateOrganization(name string, organization *Organization) (bool, error)

func (*Client) UpdatePayment 

func (c *Client) UpdatePayment(payment *Payment) (bool, error)

func (*Client) UpdatePermission 

func (c *Client) UpdatePermission(permission *Permission) (bool, error)

func (*Client) UpdatePermissionForColumns 

func (c *Client) UpdatePermissionForColumns(permission *Permission, columns []string) (bool, error)

func (*Client) UpdatePlan 

func (c *Client) UpdatePlan(plan *Plan) (bool, error)

func (*Client) UpdatePolicy added in v0.43.1 

func (c *Client) UpdatePolicy(enforcer *Enforcer, oldpolicy *CasbinRule, newpolicy *CasbinRule) (bool, error)

func (*Client) UpdatePricing 

func (c *Client) UpdatePricing(pricing *Pricing) (bool, error)

func (*Client) UpdateProduct 

func (c *Client) UpdateProduct(product *Product) (bool, error)

func (*Client) UpdateProvider 

func (c *Client) UpdateProvider(provider *Provider) (bool, error)

func (*Client) UpdateRole 

func (c *Client) UpdateRole(role *Role) (bool, error)

func (*Client) UpdateRoleForColumns 

func (c *Client) UpdateRoleForColumns(role *Role, columns []string) (bool, error)

func (*Client) UpdateSession 

func (c *Client) UpdateSession(session *Session) (bool, error)

func (*Client) UpdateSessionForColumns 

func (c *Client) UpdateSessionForColumns(session *Session, columns []string) (bool, error)

func (*Client) UpdateSubscription 

func (c *Client) UpdateSubscription(subscription *Subscription) (bool, error)

func (*Client) UpdateSyncer 

func (c *Client) UpdateSyncer(syncer *Syncer) (bool, error)

func (*Client) UpdateToken 

func (c *Client) UpdateToken(token *Token) (bool, error)

func (*Client) UpdateTokenForColumns 

func (c *Client) UpdateTokenForColumns(token *Token, columns []string) (bool, error)

func (*Client) UpdateTransaction added in v0.43.1 

func (c *Client) UpdateTransaction(transaction *Transaction) (bool, error)

func (*Client) UpdateUser 

func (c *Client) UpdateUser(user *User) (bool, error)

func (*Client) UpdateUserById 

func (c *Client) UpdateUserById(id string, user *User) (bool, error)

func (*Client) UpdateUserForColumns 

func (c *Client) UpdateUserForColumns(user *User, columns []string) (bool, error)

func (*Client) UpdateWebhook 

func (c *Client) UpdateWebhook(webhook *Webhook) (bool, error)

func (*Client) UploadResource 

func (c *Client) UploadResource(user string, tag string, parent string, fullFilePath string, fileBytes []byte) (string, string, error)

func (*Client) UploadResourceEx 

func (c *Client) UploadResourceEx(user string, tag string, parent string, fullFilePath string, fileBytes []byte, createdTime string, description string) (string, string, error)

type Enforcer 

type Enforcer struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	UpdatedTime string `xorm:"varchar(100) updated" json:"updatedTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Description string `xorm:"varchar(100)" json:"description"`

	Model     string `xorm:"varchar(100)" json:"model"`
	Adapter   string `xorm:"varchar(100)" json:"adapter"`
	IsEnabled bool   `json:"isEnabled"`
}

func GetEnforcer 

func GetEnforcer(name string) (*Enforcer, error)

func GetEnforcers 

func GetEnforcers() ([]*Enforcer, error)

func GetPaginationEnforcers 

func GetPaginationEnforcers(p int, pageSize int, queryMap map[string]string) ([]*Enforcer, int, error)

type Group 

type Group struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk unique index" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	UpdatedTime string `xorm:"varchar(100)" json:"updatedTime"`

	DisplayName  string  `xorm:"varchar(100)" json:"displayName"`
	Manager      string  `xorm:"varchar(100)" json:"manager"`
	ContactEmail string  `xorm:"varchar(100)" json:"contactEmail"`
	Type         string  `xorm:"varchar(100)" json:"type"`
	ParentId     string  `xorm:"varchar(100)" json:"parentId"`
	IsTopGroup   bool    `xorm:"bool" json:"isTopGroup"`
	Users        []*User `xorm:"-" json:"users"`

	Title    string   `json:"title,omitempty"`
	Key      string   `json:"key,omitempty"`
	Children []*Group `json:"children,omitempty"`

	IsEnabled bool `json:"isEnabled"`
}

func GetGroup 

func GetGroup(name string) (*Group, error)

func GetGroups 

func GetGroups() ([]*Group, error)

func GetPaginationGroups 

func GetPaginationGroups(p int, pageSize int, queryMap map[string]string) ([]*Group, int, error)

type HttpClient 

type HttpClient interface {
	Do(*http.Request) (*http.Response, error)
}

HttpClient interface has the method required to use a type as custom http client. The net/*http.Client type satisfies this interface.

type IntroSpectTokenResult added in v0.43.1 

type IntroSpectTokenResult struct {
	Active    bool      `json:"active"`
	ClientId  string    `json:"client_id"`
	Username  string    `json:"username"`
	TokenType string    `json:"token_type"`
	Exp       uint      `json:"exp"`
	Iat       uint      `json:"iat"`
	Nbf       uint      `json:"nbf"`
	Sub       uuid.UUID `json:"sub"`
	Aud       []string  `json:"aud"`
	Iss       string    `json:"iss"`
	Jti       string    `json:"jti"`
}

type ManagedAccount 

type ManagedAccount struct {
	Application string `xorm:"varchar(100)" json:"application"`
	Username    string `xorm:"varchar(100)" json:"username"`
	Password    string `xorm:"varchar(100)" json:"password"`
	SigninUrl   string `xorm:"varchar(200)" json:"signinUrl"`
}

type MfaItem 

type MfaItem struct {
	Name string `json:"name"`
	Rule string `json:"rule"`
}

type MfaProps 

type MfaProps struct {
	Enabled       bool     `json:"enabled"`
	IsPreferred   bool     `json:"isPreferred"`
	MfaType       string   `json:"mfaType" form:"mfaType"`
	Secret        string   `json:"secret,omitempty"`
	CountryCode   string   `json:"countryCode,omitempty"`
	URL           string   `json:"url,omitempty"`
	RecoveryCodes []string `json:"recoveryCodes,omitempty"`
}

type Model 

type Model struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk unique index" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	UpdatedTime string `xorm:"varchar(100)" json:"updatedTime"`

	DisplayName  string  `xorm:"varchar(100)" json:"displayName"`
	Manager      string  `xorm:"varchar(100)" json:"manager"`
	ContactEmail string  `xorm:"varchar(100)" json:"contactEmail"`
	Type         string  `xorm:"varchar(100)" json:"type"`
	ParentId     string  `xorm:"varchar(100)" json:"parentId"`
	IsTopModel   bool    `xorm:"bool" json:"isTopModel"`
	Users        []*User `xorm:"-" json:"users"`

	Title    string   `json:"title,omitempty"`
	Key      string   `json:"key,omitempty"`
	Children []*Model `json:"children,omitempty"`

	ModelText string `xorm:"mediumtext" json:"modelText"`
	IsEnabled bool   `json:"isEnabled"`
}

func GetModel 

func GetModel(name string) (*Model, error)

func GetModels 

func GetModels() ([]*Model, error)

func GetPaginationModels 

func GetPaginationModels(p int, pageSize int, queryMap map[string]string) ([]*Model, int, error)

type Organization 

type Organization struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	DisplayName        string     `xorm:"varchar(100)" json:"displayName"`
	WebsiteUrl         string     `xorm:"varchar(100)" json:"websiteUrl"`
	Favicon            string     `xorm:"varchar(100)" json:"favicon"`
	PasswordType       string     `xorm:"varchar(100)" json:"passwordType"`
	PasswordSalt       string     `xorm:"varchar(100)" json:"passwordSalt"`
	PasswordOptions    []string   `xorm:"varchar(100)" json:"passwordOptions"`
	CountryCodes       []string   `xorm:"varchar(200)"  json:"countryCodes"`
	DefaultAvatar      string     `xorm:"varchar(200)" json:"defaultAvatar"`
	DefaultApplication string     `xorm:"varchar(100)" json:"defaultApplication"`
	Tags               []string   `xorm:"mediumtext" json:"tags"`
	Languages          []string   `xorm:"varchar(255)" json:"languages"`
	ThemeData          *ThemeData `xorm:"json" json:"themeData"`
	MasterPassword     string     `xorm:"varchar(100)" json:"masterPassword"`
	DefaultPassword    string     `xorm:"varchar(100)" json:"defaultPassword"`
	InitScore          int        `json:"initScore"`
	EnableSoftDeletion bool       `json:"enableSoftDeletion"`
	IsProfilePublic    bool       `json:"isProfilePublic"`

	MfaItems     []*MfaItem     `xorm:"varchar(300)" json:"mfaItems"`
	AccountItems []*AccountItem `xorm:"varchar(5000)" json:"accountItems"`
}

Organization has the same definition as https://github.com/casdoor/casdoor/blob/master/object/organization.go#L25

func GetOrganization 

func GetOrganization(name string) (*Organization, error)

func GetOrganizationNames 

func GetOrganizationNames() ([]*Organization, error)

func GetOrganizations 

func GetOrganizations() ([]*Organization, error)

func GetPaginationOrganizations added in v0.34.3 

func GetPaginationOrganizations(p int, pageSize int, queryMap map[string]string) ([]*Organization, int, error)

type Payment 

type Payment struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	// Payment Provider Info
	Provider string `xorm:"varchar(100)" json:"provider"`
	Type     string `xorm:"varchar(100)" json:"type"`
	// Product Info
	ProductName        string  `xorm:"varchar(100)" json:"productName"`
	ProductDisplayName string  `xorm:"varchar(100)" json:"productDisplayName"`
	Detail             string  `xorm:"varchar(255)" json:"detail"`
	Tag                string  `xorm:"varchar(100)" json:"tag"`
	Currency           string  `xorm:"varchar(100)" json:"currency"`
	Price              float64 `json:"price"`
	ReturnUrl          string  `xorm:"varchar(1000)" json:"returnUrl"`
	// Payer Info
	User         string `xorm:"varchar(100)" json:"user"`
	PersonName   string `xorm:"varchar(100)" json:"personName"`
	PersonIdCard string `xorm:"varchar(100)" json:"personIdCard"`
	PersonEmail  string `xorm:"varchar(100)" json:"personEmail"`
	PersonPhone  string `xorm:"varchar(100)" json:"personPhone"`
	// Invoice Info
	InvoiceType   string `xorm:"varchar(100)" json:"invoiceType"`
	InvoiceTitle  string `xorm:"varchar(100)" json:"invoiceTitle"`
	InvoiceTaxId  string `xorm:"varchar(100)" json:"invoiceTaxId"`
	InvoiceRemark string `xorm:"varchar(100)" json:"invoiceRemark"`
	InvoiceUrl    string `xorm:"varchar(255)" json:"invoiceUrl"`
	// Order Info
	OutOrderId string `xorm:"varchar(100)" json:"outOrderId"`
	PayUrl     string `xorm:"varchar(2000)" json:"payUrl"`
	// State      pp.PaymentState `xorm:"varchaFr(100)" json:"state"`
	State   string `xorm:"varchar(100)" json:"state"`
	Message string `xorm:"varchar(2000)" json:"message"`
}

func GetPaginationPayments 

func GetPaginationPayments(p int, pageSize int, queryMap map[string]string) ([]*Payment, int, error)

func GetPayment 

func GetPayment(name string) (*Payment, error)

func GetPayments 

func GetPayments() ([]*Payment, error)

func GetUserPayments 

func GetUserPayments(userName string) ([]*Payment, error)

type Permission 

type Permission struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Description string `xorm:"varchar(100)" json:"description"`

	Users   []string `xorm:"mediumtext" json:"users"`
	Groups  []string `xorm:"mediumtext" json:"groups"`
	Roles   []string `xorm:"mediumtext" json:"roles"`
	Domains []string `xorm:"mediumtext" json:"domains"`

	Model        string   `xorm:"varchar(100)" json:"model"`
	Adapter      string   `xorm:"varchar(100)" json:"adapter"`
	ResourceType string   `xorm:"varchar(100)" json:"resourceType"`
	Resources    []string `xorm:"mediumtext" json:"resources"`
	Actions      []string `xorm:"mediumtext" json:"actions"`
	Effect       string   `xorm:"varchar(100)" json:"effect"`
	IsEnabled    bool     `json:"isEnabled"`

	Submitter   string `xorm:"varchar(100)" json:"submitter"`
	Approver    string `xorm:"varchar(100)" json:"approver"`
	ApproveTime string `xorm:"varchar(100)" json:"approveTime"`
	State       string `xorm:"varchar(100)" json:"state"`
}

func GetPaginationPermissions 

func GetPaginationPermissions(p int, pageSize int, queryMap map[string]string) ([]*Permission, int, error)

func GetPermission 

func GetPermission(name string) (*Permission, error)

func GetPermissions 

func GetPermissions() ([]*Permission, error)

func GetPermissionsByRole 

func GetPermissionsByRole(name string) ([]*Permission, error)

type PermissionRule 

type PermissionRule struct {
	Ptype string `xorm:"varchar(100) index not null default ''" json:"ptype"`
	V0    string `xorm:"varchar(100) index not null default ''" json:"v0"`
	V1    string `xorm:"varchar(100) index not null default ''" json:"v1"`
	V2    string `xorm:"varchar(100) index not null default ''" json:"v2"`
	V3    string `xorm:"varchar(100) index not null default ''" json:"v3"`
	V4    string `xorm:"varchar(100) index not null default ''" json:"v4"`
	V5    string `xorm:"varchar(100) index not null default ''" json:"v5"`
	Id    string `xorm:"varchar(100) index not null default ''" json:"id"`
}

type Plan 

type Plan struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Description string `xorm:"varchar(100)" json:"description"`

	PricePerMonth float64 `json:"pricePerMonth"`
	PricePerYear  float64 `json:"pricePerYear"`
	Currency      string  `xorm:"varchar(100)" json:"currency"`
	IsEnabled     bool    `json:"isEnabled"`

	Role    string   `xorm:"varchar(100)" json:"role"`
	Options []string `xorm:"-" json:"options"`
}

Plan has the same definition as https://github.com/casdoor/casdoor/blob/master/object/plan.go#L24

func GetPaginationPlans 

func GetPaginationPlans(p int, pageSize int, queryMap map[string]string) ([]*Plan, int, error)

func GetPlan 

func GetPlan(name string) (*Plan, error)

func GetPlans 

func GetPlans() ([]*Plan, error)

type Pricing 

type Pricing struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Description string `xorm:"varchar(100)" json:"description"`

	Plans         []string `xorm:"mediumtext" json:"plans"`
	IsEnabled     bool     `json:"isEnabled"`
	TrialDuration int      `json:"trialDuration"`
	Application   string   `xorm:"varchar(100)" json:"application"`

	Submitter   string `xorm:"varchar(100)" json:"submitter"`
	Approver    string `xorm:"varchar(100)" json:"approver"`
	ApproveTime string `xorm:"varchar(100)" json:"approveTime"`

	State string `xorm:"varchar(100)" json:"state"`
}

Pricing has the same definition as https://github.com/casdoor/casdoor/blob/master/object/pricing.go#L24

func GetPaginationPricings 

func GetPaginationPricings(p int, pageSize int, queryMap map[string]string) ([]*Pricing, int, error)

func GetPricing 

func GetPricing(name string) (*Pricing, error)

func GetPricings 

func GetPricings() ([]*Pricing, error)

type Product 

type Product struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`

	Image       string   `xorm:"varchar(100)" json:"image"`
	Detail      string   `xorm:"varchar(255)" json:"detail"`
	Description string   `xorm:"varchar(100)" json:"description"`
	Tag         string   `xorm:"varchar(100)" json:"tag"`
	Currency    string   `xorm:"varchar(100)" json:"currency"`
	Price       float64  `json:"price"`
	Quantity    int      `json:"quantity"`
	Sold        int      `json:"sold"`
	Providers   []string `xorm:"varchar(100)" json:"providers"`
	ReturnUrl   string   `xorm:"varchar(1000)" json:"returnUrl"`

	State string `xorm:"varchar(100)" json:"state"`

	ProviderObjs []*Provider `xorm:"-" json:"providerObjs"`
}

func BuyProduct 

func BuyProduct(name string, providerName string) (*Product, error)

func GetPaginationProducts 

func GetPaginationProducts(p int, pageSize int, queryMap map[string]string) ([]*Product, int, error)

func GetProduct 

func GetProduct(name string) (*Product, error)

func GetProducts 

func GetProducts() ([]*Product, error)

type Provider 

type Provider struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk unique" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	DisplayName       string            `xorm:"varchar(100)" json:"displayName"`
	Category          string            `xorm:"varchar(100)" json:"category"`
	Type              string            `xorm:"varchar(100)" json:"type"`
	SubType           string            `xorm:"varchar(100)" json:"subType"`
	Method            string            `xorm:"varchar(100)" json:"method"`
	ClientId          string            `xorm:"varchar(100)" json:"clientId"`
	ClientSecret      string            `xorm:"varchar(2000)" json:"clientSecret"`
	ClientId2         string            `xorm:"varchar(100)" json:"clientId2"`
	ClientSecret2     string            `xorm:"varchar(100)" json:"clientSecret2"`
	Cert              string            `xorm:"varchar(100)" json:"cert"`
	CustomAuthUrl     string            `xorm:"varchar(200)" json:"customAuthUrl"`
	CustomTokenUrl    string            `xorm:"varchar(200)" json:"customTokenUrl"`
	CustomUserInfoUrl string            `xorm:"varchar(200)" json:"customUserInfoUrl"`
	Scopes            string            `xorm:"varchar(100)" json:"scopes"`
	UserMapping       map[string]string `xorm:"varchar(500)" json:"userMapping"`

	Host       string `xorm:"varchar(100)" json:"host"`
	Port       int    `json:"port"`
	DisableSsl bool   `json:"disableSsl"` // If the provider type is WeChat, DisableSsl means EnableQRCode
	Title      string `xorm:"varchar(100)" json:"title"`
	Content    string `xorm:"varchar(1000)" json:"content"` // If provider type is WeChat, Content means QRCode string by Base64 encoding
	Receiver   string `xorm:"varchar(100)" json:"receiver"`

	RegionId     string `xorm:"varchar(100)" json:"regionId"`
	SignName     string `xorm:"varchar(100)" json:"signName"`
	TemplateCode string `xorm:"varchar(100)" json:"templateCode"`
	AppId        string `xorm:"varchar(100)" json:"appId"`

	Endpoint         string `xorm:"varchar(1000)" json:"endpoint"`
	IntranetEndpoint string `xorm:"varchar(100)" json:"intranetEndpoint"`
	Domain           string `xorm:"varchar(100)" json:"domain"`
	Bucket           string `xorm:"varchar(100)" json:"bucket"`
	PathPrefix       string `xorm:"varchar(100)" json:"pathPrefix"`

	Metadata               string `xorm:"mediumtext" json:"metadata"`
	IdP                    string `xorm:"mediumtext" json:"idP"`
	IssuerUrl              string `xorm:"varchar(100)" json:"issuerUrl"`
	EnableSignAuthnRequest bool   `json:"enableSignAuthnRequest"`

	ProviderUrl string `xorm:"varchar(200)" json:"providerUrl"`
}

func GetPaginationProviders 

func GetPaginationProviders(p int, pageSize int, queryMap map[string]string) ([]*Provider, int, error)

func GetProvider 

func GetProvider(name string) (*Provider, error)

func GetProviders 

func GetProviders() ([]*Provider, error)

type ProviderItem 

type ProviderItem struct {
	Owner string `json:"owner"`
	Name  string `json:"name"`

	CanSignUp   bool      `json:"canSignUp"`
	CanSignIn   bool      `json:"canSignIn"`
	CanUnlink   bool      `json:"canUnlink"`
	Prompted    bool      `json:"prompted"`
	SignupGroup string    `json:"signupGroup"`
	Rule        string    `json:"rule"`
	Provider    *Provider `json:"provider"`
}

type Record 

type Record struct {
	Id int `xorm:"int notnull pk autoincr" json:"id"`

	Owner       string `xorm:"varchar(100) index" json:"owner"`
	Name        string `xorm:"varchar(100) index" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	Organization string `xorm:"varchar(100)" json:"organization"`
	ClientIp     string `xorm:"varchar(100)" json:"clientIp"`
	User         string `xorm:"varchar(100)" json:"user"`
	Method       string `xorm:"varchar(100)" json:"method"`
	RequestUri   string `xorm:"varchar(1000)" json:"requestUri"`
	Action       string `xorm:"varchar(1000)" json:"action"`

	Object       string `xorm:"-" json:"object"`
	ExtendedUser *User  `xorm:"-" json:"extendedUser"`

	IsTriggered bool `json:"isTriggered"`
}

func GetPaginationRecords 

func GetPaginationRecords(p int, pageSize int, queryMap map[string]string) ([]*Record, int, error)

func GetRecord 

func GetRecord(name string) (*Record, error)

func GetRecords 

func GetRecords() ([]*Record, error)

type Resource 

type Resource struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(180) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	User        string `xorm:"varchar(100)" json:"user"`
	Provider    string `xorm:"varchar(100)" json:"provider"`
	Application string `xorm:"varchar(100)" json:"application"`
	Tag         string `xorm:"varchar(100)" json:"tag"`
	Parent      string `xorm:"varchar(100)" json:"parent"`
	FileName    string `xorm:"varchar(255)" json:"fileName"`
	FileType    string `xorm:"varchar(100)" json:"fileType"`
	FileFormat  string `xorm:"varchar(100)" json:"fileFormat"`
	FileSize    int    `json:"fileSize"`
	Url         string `xorm:"varchar(255)" json:"url"`
	Description string `xorm:"varchar(255)" json:"description"`
}

Resource has the same definition as https://github.com/casdoor/casdoor/blob/master/object/resource.go#L24

func GetPaginationResources 

func GetPaginationResources(owner, user, field, value string, pageSize, page int, sortField, sortOrder string) ([]*Resource, error)

func GetResource 

func GetResource(id string) (*Resource, error)

func GetResourceEx 

func GetResourceEx(owner, name string) (*Resource, error)

func GetResources 

func GetResources(owner, user, field, value, sortField, sortOrder string) ([]*Resource, error)

type Response 

type Response struct {
	Status string      `json:"status"`
	Msg    string      `json:"msg"`
	Data   interface{} `json:"data"`
	Data2  interface{} `json:"data2"`
}

func DoGetResponse 

func DoGetResponse(url string) (*Response, error)

DoGetResponse is a general function to get response from param url through HTTP Get method.

func DoPost 

func DoPost(action string, queryMap map[string]string, postBytes []byte, isForm, isFile bool) (*Response, error)

type Role 

type Role struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Description string `xorm:"varchar(100)" json:"description"`

	Users     []string `xorm:"mediumtext" json:"users"`
	Roles     []string `xorm:"mediumtext" json:"roles"`
	Domains   []string `xorm:"mediumtext" json:"domains"`
	IsEnabled bool     `json:"isEnabled"`
}

Role has the same definition as https://github.com/casdoor/casdoor/blob/master/object/role.go#L24

func GetPaginationRoles 

func GetPaginationRoles(p int, pageSize int, queryMap map[string]string) ([]*Role, int, error)

func GetRole 

func GetRole(name string) (*Role, error)

func GetRoles 

func GetRoles() ([]*Role, error)

type SamlItem added in v0.34.2 

type SamlItem struct {
	Name       string `json:"name"`
	NameFormat string `json:"nameformat"`
	Value      string `json:"value"`
}

type Session 

type Session struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	Application string `xorm:"varchar(100) notnull pk" json:"application"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	SessionId []string `json:"sessionId"`
}

func GetPaginationSessions 

func GetPaginationSessions(p int, pageSize int, queryMap map[string]string) ([]*Session, int, error)

func GetSession 

func GetSession(name string, application string) (*Session, error)

func GetSessions 

func GetSessions() ([]*Session, error)

type SigninMethod added in v0.34.2 

type SigninMethod struct {
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	Rule        string `json:"rule"`
}

type SignupItem 

type SignupItem struct {
	Name        string `json:"name"`
	Visible     bool   `json:"visible"`
	Required    bool   `json:"required"`
	Prompted    bool   `json:"prompted"`
	Label       string `json:"label"`
	Placeholder string `json:"placeholder"`
	Rule        string `json:"rule"`
}

type Subscription 

type Subscription struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`

	StartDate   time.Time `json:"startDate"`
	EndDate     time.Time `json:"endDate"`
	Duration    int       `json:"duration"`
	Description string    `xorm:"varchar(100)" json:"description"`

	User string `xorm:"mediumtext" json:"user"`
	Plan string `xorm:"varchar(100)" json:"plan"`

	IsEnabled   bool   `json:"isEnabled"`
	Submitter   string `xorm:"varchar(100)" json:"submitter"`
	Approver    string `xorm:"varchar(100)" json:"approver"`
	ApproveTime string `xorm:"varchar(100)" json:"approveTime"`

	State string `xorm:"varchar(100)" json:"state"`
}

Subscription has the same definition as https://github.com/casdoor/casdoor/blob/master/object/subscription.go#L24

func GetPaginationSubscriptions 

func GetPaginationSubscriptions(p int, pageSize int, queryMap map[string]string) ([]*Subscription, int, error)

func GetSubscription 

func GetSubscription(name string) (*Subscription, error)

func GetSubscriptions 

func GetSubscriptions() ([]*Subscription, error)

type Syncer 

type Syncer struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	Organization string `xorm:"varchar(100)" json:"organization"`
	Type         string `xorm:"varchar(100)" json:"type"`

	Host             string         `xorm:"varchar(100)" json:"host"`
	Port             int            `json:"port"`
	User             string         `xorm:"varchar(100)" json:"user"`
	Password         string         `xorm:"varchar(100)" json:"password"`
	DatabaseType     string         `xorm:"varchar(100)" json:"databaseType"`
	Database         string         `xorm:"varchar(100)" json:"database"`
	Table            string         `xorm:"varchar(100)" json:"table"`
	TablePrimaryKey  string         `xorm:"varchar(100)" json:"tablePrimaryKey"`
	TableColumns     []*TableColumn `xorm:"mediumtext" json:"tableColumns"`
	AffiliationTable string         `xorm:"varchar(100)" json:"affiliationTable"`
	AvatarBaseUrl    string         `xorm:"varchar(100)" json:"avatarBaseUrl"`
	ErrorText        string         `xorm:"mediumtext" json:"errorText"`
	SyncInterval     int            `json:"syncInterval"`
	IsReadOnly       bool           `json:"isReadOnly"`
	IsEnabled        bool           `json:"isEnabled"`
}

Syncer has the same definition as https://github.com/casdoor/casdoor/blob/master/object/syncer.go#L24

func GetPaginationSyncers 

func GetPaginationSyncers(p int, pageSize int, queryMap map[string]string) ([]*Syncer, int, error)

func GetSyncer 

func GetSyncer(name string) (*Syncer, error)

func GetSyncers 

func GetSyncers() ([]*Syncer, error)

type TableColumn 

type TableColumn struct {
	Name        string   `json:"name"`
	Type        string   `json:"type"`
	CasdoorName string   `json:"casdoorName"`
	IsKey       bool     `json:"isKey"`
	IsHashed    bool     `json:"isHashed"`
	Values      []string `json:"values"`
}

type ThemeData 

type ThemeData struct {
	ThemeType    string `xorm:"varchar(30)" json:"themeType"`
	ColorPrimary string `xorm:"varchar(10)" json:"colorPrimary"`
	BorderRadius int    `xorm:"int" json:"borderRadius"`
	IsCompact    bool   `xorm:"bool" json:"isCompact"`
	IsEnabled    bool   `xorm:"bool" json:"isEnabled"`
}

type Token 

type Token struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	Application  string `xorm:"varchar(100)" json:"application"`
	Organization string `xorm:"varchar(100)" json:"organization"`
	User         string `xorm:"varchar(100)" json:"user"`

	Code          string `xorm:"varchar(100) index" json:"code"`
	AccessToken   string `xorm:"mediumtext" json:"accessToken"`
	RefreshToken  string `xorm:"mediumtext" json:"refreshToken"`
	ExpiresIn     int    `json:"expiresIn"`
	Scope         string `xorm:"varchar(100)" json:"scope"`
	TokenType     string `xorm:"varchar(100)" json:"tokenType"`
	CodeChallenge string `xorm:"varchar(100)" json:"codeChallenge"`
	CodeIsUsed    bool   `json:"codeIsUsed"`
	CodeExpireIn  int64  `json:"codeExpireIn"`
}

Token has the same definition as https://github.com/casdoor/casdoor/blob/master/object/token.go#L45

func GetPaginationTokens 

func GetPaginationTokens(p int, pageSize int, queryMap map[string]string) ([]*Token, int, error)

func GetToken 

func GetToken(name string) (*Token, error)

func GetTokens 

func GetTokens() ([]*Token, error)

type Transaction added in v0.43.1 

type Transaction struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	DisplayName string `xorm:"varchar(100)" json:"displayName"`
	// Transaction Provider Info
	Provider string `xorm:"varchar(100)" json:"provider"`
	Category string `xorm:"varchar(100)" json:"category"`
	Type     string `xorm:"varchar(100)" json:"type"`
	// Product Info
	ProductName        string  `xorm:"varchar(100)" json:"productName"`
	ProductDisplayName string  `xorm:"varchar(100)" json:"productDisplayName"`
	Detail             string  `xorm:"varchar(255)" json:"detail"`
	Tag                string  `xorm:"varchar(100)" json:"tag"`
	Currency           string  `xorm:"varchar(100)" json:"currency"`
	Amount             float64 `json:"amount"`
	ReturnUrl          string  `xorm:"varchar(1000)" json:"returnUrl"`
	// User Info
	User        string `xorm:"varchar(100)" json:"user"`
	Application string `xorm:"varchar(100)" json:"application"`
	Payment     string `xorm:"varchar(100)" json:"payment"`

	State string `xorm:"varchar(100)" json:"state"`
}

Transaction has the same definition as https://github.com/casdoor/casdoor/blob/master/object/transaction.go#L24

func GetPaginationTransactions added in v0.43.1 

func GetPaginationTransactions(p int, pageSize int, queryMap map[string]string) ([]*Transaction, int, error)

func GetTransaction added in v0.43.1 

func GetTransaction(name string) (*Transaction, error)

func GetTransactions added in v0.43.1 

func GetTransactions() ([]*Transaction, error)

func GetUserTransactions added in v0.43.1 

func GetUserTransactions(userName string) ([]*Transaction, error)

type User 

type User struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100) index" json:"createdTime"`
	UpdatedTime string `xorm:"varchar(100)" json:"updatedTime"`

	Id                string   `xorm:"varchar(100) index" json:"id"`
	ExternalId        string   `xorm:"varchar(100) index" json:"externalId"`
	Type              string   `xorm:"varchar(100)" json:"type"`
	Password          string   `xorm:"varchar(100)" json:"password"`
	PasswordSalt      string   `xorm:"varchar(100)" json:"passwordSalt"`
	PasswordType      string   `xorm:"varchar(100)" json:"passwordType"`
	DisplayName       string   `xorm:"varchar(100)" json:"displayName"`
	FirstName         string   `xorm:"varchar(100)" json:"firstName"`
	LastName          string   `xorm:"varchar(100)" json:"lastName"`
	Avatar            string   `xorm:"varchar(500)" json:"avatar"`
	AvatarType        string   `xorm:"varchar(100)" json:"avatarType"`
	PermanentAvatar   string   `xorm:"varchar(500)" json:"permanentAvatar"`
	Email             string   `xorm:"varchar(100) index" json:"email"`
	EmailVerified     bool     `json:"emailVerified"`
	Phone             string   `xorm:"varchar(20) index" json:"phone"`
	CountryCode       string   `xorm:"varchar(6)" json:"countryCode"`
	Region            string   `xorm:"varchar(100)" json:"region"`
	Location          string   `xorm:"varchar(100)" json:"location"`
	Address           []string `json:"address"`
	Affiliation       string   `xorm:"varchar(100)" json:"affiliation"`
	Title             string   `xorm:"varchar(100)" json:"title"`
	IdCardType        string   `xorm:"varchar(100)" json:"idCardType"`
	IdCard            string   `xorm:"varchar(100) index" json:"idCard"`
	Homepage          string   `xorm:"varchar(100)" json:"homepage"`
	Bio               string   `xorm:"varchar(100)" json:"bio"`
	Tag               string   `xorm:"varchar(100)" json:"tag"`
	Language          string   `xorm:"varchar(100)" json:"language"`
	Gender            string   `xorm:"varchar(100)" json:"gender"`
	Birthday          string   `xorm:"varchar(100)" json:"birthday"`
	Education         string   `xorm:"varchar(100)" json:"education"`
	Score             int      `json:"score"`
	Karma             int      `json:"karma"`
	Ranking           int      `json:"ranking"`
	IsDefaultAvatar   bool     `json:"isDefaultAvatar"`
	IsOnline          bool     `json:"isOnline"`
	IsAdmin           bool     `json:"isAdmin"`
	IsForbidden       bool     `json:"isForbidden"`
	IsDeleted         bool     `json:"isDeleted"`
	SignupApplication string   `xorm:"varchar(100)" json:"signupApplication"`
	Hash              string   `xorm:"varchar(100)" json:"hash"`
	PreHash           string   `xorm:"varchar(100)" json:"preHash"`
	AccessKey         string   `xorm:"varchar(100)" json:"accessKey"`
	AccessSecret      string   `xorm:"varchar(100)" json:"accessSecret"`

	CreatedIp      string `xorm:"varchar(100)" json:"createdIp"`
	LastSigninTime string `xorm:"varchar(100)" json:"lastSigninTime"`
	LastSigninIp   string `xorm:"varchar(100)" json:"lastSigninIp"`

	GitHub          string `xorm:"github varchar(100)" json:"github"`
	Google          string `xorm:"varchar(100)" json:"google"`
	QQ              string `xorm:"qq varchar(100)" json:"qq"`
	WeChat          string `xorm:"wechat varchar(100)" json:"wechat"`
	Facebook        string `xorm:"facebook varchar(100)" json:"facebook"`
	DingTalk        string `xorm:"dingtalk varchar(100)" json:"dingtalk"`
	Weibo           string `xorm:"weibo varchar(100)" json:"weibo"`
	Gitee           string `xorm:"gitee varchar(100)" json:"gitee"`
	LinkedIn        string `xorm:"linkedin varchar(100)" json:"linkedin"`
	Wecom           string `xorm:"wecom varchar(100)" json:"wecom"`
	Lark            string `xorm:"lark varchar(100)" json:"lark"`
	Gitlab          string `xorm:"gitlab varchar(100)" json:"gitlab"`
	Adfs            string `xorm:"adfs varchar(100)" json:"adfs"`
	Baidu           string `xorm:"baidu varchar(100)" json:"baidu"`
	Alipay          string `xorm:"alipay varchar(100)" json:"alipay"`
	Casdoor         string `xorm:"casdoor varchar(100)" json:"casdoor"`
	Infoflow        string `xorm:"infoflow varchar(100)" json:"infoflow"`
	Apple           string `xorm:"apple varchar(100)" json:"apple"`
	AzureAD         string `xorm:"azuread varchar(100)" json:"azuread"`
	Slack           string `xorm:"slack varchar(100)" json:"slack"`
	Steam           string `xorm:"steam varchar(100)" json:"steam"`
	Bilibili        string `xorm:"bilibili varchar(100)" json:"bilibili"`
	Okta            string `xorm:"okta varchar(100)" json:"okta"`
	Douyin          string `xorm:"douyin varchar(100)" json:"douyin"`
	Line            string `xorm:"line varchar(100)" json:"line"`
	Amazon          string `xorm:"amazon varchar(100)" json:"amazon"`
	Auth0           string `xorm:"auth0 varchar(100)" json:"auth0"`
	BattleNet       string `xorm:"battlenet varchar(100)" json:"battlenet"`
	Bitbucket       string `xorm:"bitbucket varchar(100)" json:"bitbucket"`
	Box             string `xorm:"box varchar(100)" json:"box"`
	CloudFoundry    string `xorm:"cloudfoundry varchar(100)" json:"cloudfoundry"`
	Dailymotion     string `xorm:"dailymotion varchar(100)" json:"dailymotion"`
	Deezer          string `xorm:"deezer varchar(100)" json:"deezer"`
	DigitalOcean    string `xorm:"digitalocean varchar(100)" json:"digitalocean"`
	Discord         string `xorm:"discord varchar(100)" json:"discord"`
	Dropbox         string `xorm:"dropbox varchar(100)" json:"dropbox"`
	EveOnline       string `xorm:"eveonline varchar(100)" json:"eveonline"`
	Fitbit          string `xorm:"fitbit varchar(100)" json:"fitbit"`
	Gitea           string `xorm:"gitea varchar(100)" json:"gitea"`
	Heroku          string `xorm:"heroku varchar(100)" json:"heroku"`
	InfluxCloud     string `xorm:"influxcloud varchar(100)" json:"influxcloud"`
	Instagram       string `xorm:"instagram varchar(100)" json:"instagram"`
	Intercom        string `xorm:"intercom varchar(100)" json:"intercom"`
	Kakao           string `xorm:"kakao varchar(100)" json:"kakao"`
	Lastfm          string `xorm:"lastfm varchar(100)" json:"lastfm"`
	Mailru          string `xorm:"mailru varchar(100)" json:"mailru"`
	Meetup          string `xorm:"meetup varchar(100)" json:"meetup"`
	MicrosoftOnline string `xorm:"microsoftonline varchar(100)" json:"microsoftonline"`
	Naver           string `xorm:"naver varchar(100)" json:"naver"`
	Nextcloud       string `xorm:"nextcloud varchar(100)" json:"nextcloud"`
	OneDrive        string `xorm:"onedrive varchar(100)" json:"onedrive"`
	Oura            string `xorm:"oura varchar(100)" json:"oura"`
	Patreon         string `xorm:"patreon varchar(100)" json:"patreon"`
	Paypal          string `xorm:"paypal varchar(100)" json:"paypal"`
	SalesForce      string `xorm:"salesforce varchar(100)" json:"salesforce"`
	Shopify         string `xorm:"shopify varchar(100)" json:"shopify"`
	Soundcloud      string `xorm:"soundcloud varchar(100)" json:"soundcloud"`
	Spotify         string `xorm:"spotify varchar(100)" json:"spotify"`
	Strava          string `xorm:"strava varchar(100)" json:"strava"`
	Stripe          string `xorm:"stripe varchar(100)" json:"stripe"`
	TikTok          string `xorm:"tiktok varchar(100)" json:"tiktok"`
	Tumblr          string `xorm:"tumblr varchar(100)" json:"tumblr"`
	Twitch          string `xorm:"twitch varchar(100)" json:"twitch"`
	Twitter         string `xorm:"twitter varchar(100)" json:"twitter"`
	Typetalk        string `xorm:"typetalk varchar(100)" json:"typetalk"`
	Uber            string `xorm:"uber varchar(100)" json:"uber"`
	VK              string `xorm:"vk varchar(100)" json:"vk"`
	Wepay           string `xorm:"wepay varchar(100)" json:"wepay"`
	Xero            string `xorm:"xero varchar(100)" json:"xero"`
	Yahoo           string `xorm:"yahoo varchar(100)" json:"yahoo"`
	Yammer          string `xorm:"yammer varchar(100)" json:"yammer"`
	Yandex          string `xorm:"yandex varchar(100)" json:"yandex"`
	Zoom            string `xorm:"zoom varchar(100)" json:"zoom"`
	MetaMask        string `xorm:"metamask varchar(100)" json:"metamask"`
	Web3Onboard     string `xorm:"web3onboard varchar(100)" json:"web3onboard"`
	Custom          string `xorm:"custom varchar(100)" json:"custom"`

	// WebauthnCredentials []webauthn.Credential `xorm:"webauthnCredentials blob" json:"webauthnCredentials"`
	PreferredMfaType string   `xorm:"varchar(100)" json:"preferredMfaType"`
	RecoveryCodes    []string `xorm:"varchar(1000)" json:"recoveryCodes"`
	TotpSecret       string   `xorm:"varchar(100)" json:"totpSecret"`
	MfaPhoneEnabled  bool     `json:"mfaPhoneEnabled"`
	MfaEmailEnabled  bool     `json:"mfaEmailEnabled"`

	Ldap       string            `xorm:"ldap varchar(100)" json:"ldap"`
	Properties map[string]string `json:"properties"`

	Roles       []*Role       `json:"roles"`
	Permissions []*Permission `json:"permissions"`
	Groups      []string      `xorm:"groups varchar(1000)" json:"groups"`

	LastSigninWrongTime string `xorm:"varchar(100)" json:"lastSigninWrongTime"`
	SigninWrongTimes    int    `json:"signinWrongTimes"`

	ManagedAccounts []ManagedAccount `xorm:"managedAccounts blob" json:"managedAccounts"`
}

User has the same definition as https://github.com/casdoor/casdoor/blob/master/object/user.go#L24

func GetGlobalUsers 

func GetGlobalUsers() ([]*User, error)

func GetPaginationUsers 

func GetPaginationUsers(p int, pageSize int, queryMap map[string]string) ([]*User, int, error)

func GetSortedUsers 

func GetSortedUsers(sorter string, limit int) ([]*User, error)

func GetUser 

func GetUser(name string) (*User, error)

func GetUserByEmail 

func GetUserByEmail(email string) (*User, error)

func GetUserByPhone 

func GetUserByPhone(phone string) (*User, error)

func GetUserByUserId 

func GetUserByUserId(userId string) (*User, error)

func GetUsers 

func GetUsers() ([]*User, error)

func (User) GetId 

func (u User) GetId() string

type Userinfo 

type Userinfo struct {
	Sub         string   `json:"sub"`
	Iss         string   `json:"iss"`
	Aud         string   `json:"aud"`
	Name        string   `json:"preferred_username,omitempty"`
	DisplayName string   `json:"name,omitempty"`
	Email       string   `json:"email,omitempty"`
	Avatar      string   `json:"picture,omitempty"`
	Address     string   `json:"address,omitempty"`
	Phone       string   `json:"phone,omitempty"`
	Groups      []string `json:"groups,omitempty"`
}

type VerificationForm added in v0.43.1 

type VerificationForm struct {
	Dest          string `json:"dest"`
	Type          string `json:"type"`
	CountryCode   string `json:"countryCode"`
	ApplicationId string `json:"applicationId"`
	Method        string `json:"method"`
	CheckUser     string `json:"checkUser"`

	CaptchaType  string `json:"captchaType"`
	ClientSecret string `json:"clientSecret"`
	CaptchaToken string `json:"captchaToken"`
}

type Webhook 

type Webhook struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`

	Organization string `xorm:"varchar(100)" json:"organization"`
	Type         string `xorm:"varchar(100)" json:"type"`

	Host             string         `xorm:"varchar(100)" json:"host"`
	Port             int            `json:"port"`
	User             string         `xorm:"varchar(100)" json:"user"`
	Password         string         `xorm:"varchar(100)" json:"password"`
	DatabaseType     string         `xorm:"varchar(100)" json:"databaseType"`
	Database         string         `xorm:"varchar(100)" json:"database"`
	Table            string         `xorm:"varchar(100)" json:"table"`
	TablePrimaryKey  string         `xorm:"varchar(100)" json:"tablePrimaryKey"`
	TableColumns     []*TableColumn `xorm:"mediumtext" json:"tableColumns"`
	AffiliationTable string         `xorm:"varchar(100)" json:"affiliationTable"`
	AvatarBaseUrl    string         `xorm:"varchar(100)" json:"avatarBaseUrl"`
	ErrorText        string         `xorm:"mediumtext" json:"errorText"`
	SyncInterval     int            `json:"syncInterval"`
	IsReadOnly       bool           `json:"isReadOnly"`
	IsEnabled        bool           `json:"isEnabled"`
}

Webhook has the same definition as https://github.com/casdoor/casdoor/blob/master/object/webhook.go#L24

func GetPaginationWebhooks 

func GetPaginationWebhooks(p int, pageSize int, queryMap map[string]string) ([]*Webhook, int, error)

func GetWebhook 

func GetWebhook(name string) (*Webhook, error)

func GetWebhooks 

func GetWebhooks() ([]*Webhook, error)

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.