An open API service indexing awesome lists of open source software.

https://github.com/essentialkaos/go-crowd

Go package for working with Atlassian Crowd REST API
https://github.com/essentialkaos/go-crowd

atlassian-crowd crowd golang

Last synced: 12 months ago
JSON representation

Go package for working with Atlassian Crowd REST API

Awesome Lists containing this project

README

          


PkgGoDev
GoReportCard
GitHub Actions CI Status
GitHub Actions CodeQL Status

Usage exampleCI StatusLicense


`go-crowd` is a Go package for working with [Crowd REST API](https://developer.atlassian.com/server/crowd/crowd-rest-resources/).

> [!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

```go
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_) | [![CI](https://kaos.sh/w/go-crowd/ci.svg?branch=master)](https://kaos.sh/w/go-crowd/ci?query=branch:master) |
| `develop` (_Unstable_) | [![CI](https://kaos.sh/w/go-crowd/ci.svg?branch=develop)](https://kaos.sh/w/go-crowd/ci?query=branch:develop) |

### Contributing

Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/.github/blob/master/CONTRIBUTING.md).

### License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)