saml

Documentation

Overview

Package saml implements SAML Auth (SharePoint Online user credentials authentication)

This authentication option uses Microsoft Online Security Token Service `https://login.microsoftonline.com/extSTS.srf` and SAML tokens in order to obtain authentication cookie.

Amongst supported platform versions are:

• SharePoint Online (SPO)

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"` // Username for SharePoint Online, for example `[user]@[company].onmicrosoft.com`
	Password string `json:"password"` // User or App password
	// contains filtered or unexported fields
}

AuthCnfg - SAML auth config structure

SharePoint Online config sample:

{
  "siteUrl": "https://contoso.sharepoint.com/sites/test",
  "username": "john.doe@contoso.onmicrosoft.com",
  "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