fba

Documentation

Overview

Package fba implements FBA (Form-based authentication)

Amongst supported platform versions are:

• On-Premise: 2019, 2016, and 2013

Index

• func GetAuth(c *AuthCnfg) (string, int64, error)
• type AuthCnfg
  • func (c *AuthCnfg) GetAuth() (string, int64, error)
  • func (c *AuthCnfg) GetSiteURL() string
  • func (c *AuthCnfg) GetStrategy() string
  • func (c *AuthCnfg) ParseConfig(byteValue []byte) error
  • func (c *AuthCnfg) ReadConfig(privateFile string) error
  • func (c *AuthCnfg) SetAuth(req *http.Request, httpClient *gosip.SPClient) error
  • func (c *AuthCnfg) SetMasterkey(masterKey string)
  • func (c *AuthCnfg) WriteConfig(privateFile string) error

Functions

func GetAuth

func GetAuth(c *AuthCnfg) (string, int64, error)

GetAuth gets authentication

Types

type AuthCnfg

type AuthCnfg struct {
	SiteURL  string `json:"siteUrl"` // SPSite or SPWeb URL, which is the context target for the API calls
	Username string `json:"username"`
	Password string `json:"password"`
	// contains filtered or unexported fields
}

AuthCnfg - FBA auth config structure

On-Premises config sample:

{
  "siteUrl": "https://www.contoso.com/sites/test",
  "username": "john.doe",
  "password": "this-is-not-a-real-password"
}

func (*AuthCnfg) GetAuth

func (c *AuthCnfg) GetAuth() (string, int64, error)

GetAuth authenticates, receives access token

func (*AuthCnfg) GetSiteURL

func (c *AuthCnfg) GetSiteURL() string

GetSiteURL gets siteURL

func (*AuthCnfg) GetStrategy

func (c *AuthCnfg) GetStrategy() string

GetStrategy gets auth strategy name

func (*AuthCnfg) ParseConfig

func (c *AuthCnfg) ParseConfig(byteValue []byte) error

ParseConfig parses credentials from a provided JSON byte array content

func (*AuthCnfg) ReadConfig

func (c *AuthCnfg) ReadConfig(privateFile string) error

ReadConfig reads private config with auth options

func (*AuthCnfg) SetAuth

func (c *AuthCnfg) SetAuth(req *http.Request, httpClient *gosip.SPClient) error

SetAuth authenticate request noinspection GoUnusedParameter

func (*AuthCnfg) SetMasterkey

func (c *AuthCnfg) SetMasterkey(masterKey string)

SetMasterkey defines custom masterkey

func (*AuthCnfg) WriteConfig

func (c *AuthCnfg) WriteConfig(privateFile string) error

WriteConfig writes private config with auth options