modulepackage
3.2.3
Repository: https://github.com/essentialkaos/go-crowd.git
Documentation: pkg.go.dev
# README
Usage example • CI Status • License
go-crowd
is a Go package for working with Crowd REST API.
[!IMPORTANT] Please note that this package only supports retrieving data from the Crowd API (i.e. you cannot create or modify data with this package).
Usage example
package main
import (
"fmt"
"github.com/essentialkaos/go-crowd/v3"
)
func main() {
api, err := crowd.NewAPI("https://crowd.domain.com/crowd/", "myapp", "MySuppaPAssWOrd")
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
api.SetUserAgent("MyApp", "1.2.3")
user, err := api.GetUser("john", true)
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("%#v\n", user)
}
CI Status
Branch | Status |
---|---|
master (Stable) | |
develop (Unstable) |
License
# Functions
NewAPI creates new API struct.
SimplifyAttributes converts slice with attributes to map name->value.
# Variables
API errors.
API errors.
API errors.
API errors.
API errors.
API errors.
# Structs
API is Confluence API struct.
Attribute contains attribute info.
Group contains info about group.
GroupAttributes contains group attributes.
ListingOptions contains options for request with listing objects.
Membership contains membership info.
User contains info about user.
UserAttributes contains user attributes.
UserInfo contains basic user info (username).
# Type aliases
Attributes it is slice with attributes.