Categorygithub.com/essentialkaos/go-crowd/v3
modulepackage
3.2.3
Repository: https://github.com/essentialkaos/go-crowd.git
Documentation: pkg.go.dev

# README

PkgGoDev GoReportCard GitHub Actions CI Status GitHub Actions CodeQL Status Codebeat badge

Usage exampleCI StatusLicense


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

BranchStatus
master (Stable)CI
develop (Unstable)CI

License

Apache License, Version 2.0

# Functions

NewAPI creates new API struct.
SimplifyAttributes converts slice with attributes to map name->value.

# Constants

Groups types.
Groups types.

# 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.