Skip to content

ConductorOne/baton-bamboohr

Repository files navigation

Baton Logo

baton-bamboohr Go Reference main ci

baton-bamboohr is a connector for BambooHR built using the Baton SDK. It communicates with the BambooHR API to sync data about users.

Check out Baton to learn more the project in general.

Getting Started

brew

brew install conductorone/baton/baton conductorone/baton/baton-bamboohr
baton-bamboohr
baton resources

docker

docker run --rm -v $(pwd):/out -e BATON_COMPANY_DOMAIN=customerID -e BATON_API_KEY=apiKey ghcr.io/conductorone/baton-bamboohr:latest -f "/out/sync.c1z"
docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c1z" resources

source

go install github.com/conductorone/baton/cmd/baton@main
go install github.com/conductorone/baton-bamboohr/cmd/baton-bamboohr@main

BATON_COMPANY_DOMAIN=customerID BATON_API_KEY=apiKey
baton resources

Data Model

baton-bamboohr will pull down information about the following BambooHR resources:

  • Users
    • Users supervisors

Contributing, Support and Issues

We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small—our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a GitHub Issue!

See CONTRIBUTING.md for more details.

baton-bamboohr Command Line Usage

baton-bamboohr

Usage:
  baton-bamboohr [flags]
  baton-bamboohr [command]

Available Commands:
  capabilities       Get connector capabilities
  completion         Generate the autocompletion script for the specified shell
  help               Help about any command

Flags:
      --api-key string          required: The api key for your BambooHR account ($BATON_API_KEY)
      --client-id string        The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
      --client-secret string    The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
      --company-domain string   required: The company domain for your BambooHR account ($BATON_COMPANY_DOMAIN)
  -f, --file string             The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
  -h, --help                    help for baton-bamboohr
      --log-format string       The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
      --log-level string        The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
  -p, --provisioning            This must be set in order for provisioning actions to be enabled ($BATON_PROVISIONING)
      --skip-full-sync          This must be set to skip a full sync ($BATON_SKIP_FULL_SYNC)
      --ticketing               This must be set to enable ticketing support ($BATON_TICKETING)
  -v, --version                 version for baton-bamboohr

Use "baton-bamboohr [command] --help" for more information about a command.