client

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2021 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	// URL for the sprawl server.
	URL string `json:"url"`
	// Username for an administrator.
	Username string `json:"username"`
	// Password for the same administrator.
	Password string `json:"password"`
	// Token for session.
	Token string
}

Config for a Sprawl connection.

func (*Config) Delete 

func (cfg *Config) Delete(ep string, args sprawl.Request) error

Delete is for removal.

func (*Config) Get 

func (cfg *Config) Get(ep string, args sprawl.Request) ([]byte, error)

Get is for retrieval.

func (*Config) GetLoginToken 

func (cfg *Config) GetLoginToken() error

GetLoginToken gets a speawl login token or the current stored token if valid.

func (*Config) Post 

func (cfg *Config) Post(ep string, args sprawl.Request) ([]byte, error)

Post is for creation.

func (*Config) Put 

func (cfg *Config) Put(ep string, args sprawl.Request) error

Put is for updates.

func (*Config) Save 

func (cfg *Config) Save(fn string) error

Save Config to JSON file.

type SprawlClient 

type SprawlClient struct {
	*Config
}

SprawlClient is used to access the Sprawl API.

func New 

func New(fn string) (*SprawlClient, error)

New creates a new SprawlClient.

func NewWithSettings added in v0.5.0 

func NewWithSettings(host, username, password string) (*SprawlClient, error)

NewWithSettings creates a new SprawlClient from variables in the environment.

func (*SprawlClient) AddGroupMember added in v0.6.0 

func (c *SprawlClient) AddGroupMember(site, group, name string) error

AddGroupMember to a group on a site.

func (*SprawlClient) AddGroupPermission added in v0.7.0 

func (c *SprawlClient) AddGroupPermission(site, group, name string) error

AddGroupPermission to a group on a site.

func (*SprawlClient) AddSiteMember 

func (c *SprawlClient) AddSiteMember(site, name, data string, admin bool) error

AddSiteMember to a site.

func (*SprawlClient) AuthUser added in v0.11.0 

func (c *SprawlClient) AuthUser(name, password string) (string, error)

AuthUser authenticates a user.

func (*SprawlClient) CreateGroup added in v0.6.0 

func (c *SprawlClient) CreateGroup(site, name string) error

CreateGroup on a site.

func (*SprawlClient) CreatePermission 

func (c *SprawlClient) CreatePermission(name, description string) error

CreatePermission creates a new permission with a name and description.

func (*SprawlClient) CreateSite 

func (c *SprawlClient) CreateSite(name string) error

CreateSite creates a new site.

func (*SprawlClient) CreateUser 

func (c *SprawlClient) CreateUser(username, password string) error

CreateUser with a username and password. Use UpdateUser() to set additional fields.

func (*SprawlClient) DeleteGroup added in v0.6.0 

func (c *SprawlClient) DeleteGroup(site, name string) error

DeleteGroup from a site.

func (*SprawlClient) DeletePermission 

func (c *SprawlClient) DeletePermission(name string) error

DeletePermission deletes a permission.

func (*SprawlClient) DeleteSite 

func (c *SprawlClient) DeleteSite(name string) error

DeleteSite deletes a site.

func (*SprawlClient) DeleteUser 

func (c *SprawlClient) DeleteUser(name string) error

DeleteUser permanently.

func (*SprawlClient) GetPermission added in v0.5.2 

func (c *SprawlClient) GetPermission(name string) (sprawl.Permission, error)

GetPermission returns a permission and description.

func (*SprawlClient) GetUser 

func (c *SprawlClient) GetUser(name string) (sprawl.User, error)

GetUser details.

func (*SprawlClient) ListGroupMembers added in v0.6.0 

func (c *SprawlClient) ListGroupMembers(site, group string) (sprawl.UserList, error)

ListGroupMembers lists members of a group on a site.

func (*SprawlClient) ListGroupPermissions added in v0.7.0 

func (c *SprawlClient) ListGroupPermissions(site, group string) (sprawl.PermissionList, error)

ListGroupPermissions of a group on a site.

func (*SprawlClient) ListGroups added in v0.6.0 

func (c *SprawlClient) ListGroups(site string) (sprawl.GroupList, error)

ListGroups on a site.

func (*SprawlClient) ListPermissions 

func (c *SprawlClient) ListPermissions() (sprawl.PermissionList, error)

func (*SprawlClient) ListSiteMembers 

func (c *SprawlClient) ListSiteMembers(site string) ([]sprawl.User, error)

ListSiteMembers of a site.

func (*SprawlClient) ListSites 

func (c *SprawlClient) ListSites() ([]sprawl.Site, error)

ListSites returns a list of sites.

func (*SprawlClient) ListUsers 

func (c *SprawlClient) ListUsers() ([]sprawl.User, error)

ListUsers returns a list of users.

func (*SprawlClient) RemoveGroupMember added in v0.6.0 

func (c *SprawlClient) RemoveGroupMember(site, group, name string) error

RemoveGroupMember from a group on a site.

func (*SprawlClient) RemoveGroupPermission added in v0.7.0 

func (c *SprawlClient) RemoveGroupPermission(site, group, name string) error

RemoveGroupPermission from a group on a site.

func (*SprawlClient) RemoveSiteMember 

func (c *SprawlClient) RemoveSiteMember(site, name string) error

RemoveSiteMember from a site.

func (*SprawlClient) SetPassword added in v0.7.0 

func (c *SprawlClient) SetPassword(name, password string) error

SetPassword for a user.

func (*SprawlClient) SetSiteAdmin added in v0.7.0 

func (c *SprawlClient) SetSiteAdmin(site, name string, admin bool) error

SetSiteAdmin sets admin status of a user on a site.

func (*SprawlClient) UpdatePermission 

func (c *SprawlClient) UpdatePermission(name, description string) error

UpdatePermission updates a permission with a new description.

func (*SprawlClient) UpdateUser 

func (c *SprawlClient) UpdateUser(name, password string) error

UpdateUser details like email and full name.

func (*SprawlClient) VerifyToken added in v0.12.0 

func (c *SprawlClient) VerifyToken(username, token string) error

VerifyToken checks if a token is valid.

type Token added in v0.11.0 

type Token struct {
	// Data is the token string.
	Data string `json:"token"`
}

Token from successful authentication.

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.