Skip to content

Latest commit

 

History

History
99 lines (75 loc) · 3.98 KB

README.md

File metadata and controls

99 lines (75 loc) · 3.98 KB

baton-zoom

baton-zoom is a connector for Zoom built using the Baton SDK. It communicates with the Zoom API to sync data about users, groups and roles.

Check out Baton to learn more the project in general.

Getting Started

Prerequisites

  1. Zoom server to server app created in marketplace
  2. Scopes for syncing only(no provisioning):
  • contact_group:read:list_groups:admin
  • group:read:list_groups:admin
  • group:read:list_members:admin
  • group:read:administrator:admin
  • role:read:list_roles:admin
  • role:read:list_members:admin
  • user:read:user:admin
  • user:read:list_users:admin

Scopes for provisioning (grant/revoke)

  • role:write:member:admin
  • role:delete:member:admin
  • group:write:member:admin
  • group:delete:member:admin
  1. Pro or higher plan
  2. Activate the App for Account ID, Client ID and Client Secret needed to use the API

brew

brew install conductorone/baton/baton conductorone/baton/baton-zoom
baton-zoom
baton resources

docker

docker run --rm -v $(pwd):/out -e BATON_ZOOM_CLIENT_ID=clientId BATON_ZOOM_CLIENT_SECRET=clientSecret BATON_ACCOUNT_ID=accountId ghcr.io/conductorone/baton-zoom: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-zoom/cmd/baton-zoom@main

BATON_ZOOM_CLIENT_ID=clientId BATON_ZOOM_CLIENT_SECRET=clientSecret BATON_ACCOUNT_ID=accountId
baton resources

Data Model

baton-zoom pulls down information about the following Zoom resources:

  • Users
  • Groups
  • Contact Groups
  • Roles

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-zoom Command Line Usage

baton-zoom

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

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

Flags:
      --account-id string           required: Account ID used to generate token providing access to Zoom API. ($BATON_ACCOUNT_ID)
      --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)
  -f, --file string                 The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
  -h, --help                        help for baton-zoom
      --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-zoom
      --zoom-client-id string       required: Client ID used to generate token providing access to Zoom API. ($BATON_ZOOM_CLIENT_ID)
      --zoom-client-secret string   required: Client Secret used to generate token providing access to Zoom API. ($BATON_ZOOM_CLIENT_SECRET)

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