Core terms
| Term | Definition |
|---|---|
| Baton | The connector framework: Go SDK + individual connectors |
| baton-sdk | Go library that handles sync orchestration, pagination, and connector runtime |
| Connector | A Go binary that syncs access control data from a third-party service into C1 |
| c1z | Compressed sync output file. The current format holds a Pebble checkpoint, and older SQLite-based files must be converted with baton to-pebble |
| cone | C1 CLI for access management |
| conductorone-sdk-go | Go SDK for C1 API integration |
| Meta-connector | Configuration-driven connector that maps external systems via YAML instead of Go code |
| baton-http | Meta-connector for REST APIs using YAML configuration and CEL expressions |
| baton-sql | Meta-connector for SQL databases using YAML configuration and CEL expressions |
Access control model
| Term | Definition |
|---|---|
| Resource | An entity in the target system: User, Group, Role, App, or custom type |
| Resource Type | Classification of resources (e.g., “user”, “group”, “role”) with associated traits |
| Entitlement | A permission that can be granted (e.g., “Admin on Database X”) |
| Entitlement Slug | Short label for an entitlement, unique within its resource (e.g., “member”, “admin”, “read”). The last segment of the entitlement ID |
| Grant | An assignment of an entitlement to a principal (e.g., “Alice has Admin on Database X”) |
| Principal | An entity that receives grants (typically users or service accounts) |
| Trait | Resource type classification that tells C1 how to interpret a resource, such as TRAIT_USER, TRAIT_GROUP, TRAIT_ROLE, or TRAIT_APP. See Core concepts for the full list |
| Parent Resource | Resource that contains child resources in a hierarchy (e.g., Organization containing Repositories) |
| Child Resource | Resource that exists within a parent resource context |
| ChildResourceType Annotation | Marker on parent declaring what child types it contains |
SDK concepts
| Term | Definition |
|---|---|
| ConnectorBuilderV2 | Interface a connector implements: Metadata, Validate, and ResourceSyncers |
| ResourceSyncerV2 | Interface that defines how to sync a resource type (ResourceType, List, Entitlements, Grants methods). The older ResourceSyncer interface has the same methods with different signatures |
| SyncOpAttrs | Argument that V2 syncer methods receive, holding the page token and, when enabled, the session store |
| Sync lifecycle | The connector-facing phases: resource types, resources, entitlements, and grants. The SDK also runs phases of its own, such as grant expansion |
| Sync stage | One phase of the sync lifecycle |
| Inversion of control | Pattern where SDK orchestrates when your code is called; you define builders, SDK calls them |
| Resource Builder | Implementation of ResourceSyncer for a specific resource type |
| pagination.Token | SDK type that holds the page token and the requested page size for a List, Entitlements, or Grants call |
| pagination.Bag | SDK type for managing nested pagination state (stack-based). pagination.GenBag[T] is the variant for your own state type |
| PageState | Single pagination state within a Bag (contains Token, ResourceTypeID, ResourceID) |
| uhttp | SDK package providing an HTTP client that translates HTTP statuses into the gRPC codes the SDK retries on, with optional rate limit handling |
| Annotations | Metadata attached to resources, entitlements, or grants (e.g., ChildResourceType, RawId) |
| RawId | Annotation that records the identifier the source system uses for a resource |
Execution modes
| Term | Definition |
|---|---|
| One-shot mode | CLI mode: runs once, produces a c1z file, and exits (no —client-id) |
| Daemon mode | Long-running mode that polls C1 for tasks (requires —client-id and —client-secret) |
| Hosted mode | Connector run by C1 infrastructure on behalf of customers |
| Service mode | The SDK’s other name for daemon mode. On Windows, a connector launched as a Windows service always runs in daemon mode |
| Client credentials | OAuth2 client ID and secret for authenticating connector to C1 |
| Task polling | Daemon mode behavior of periodically checking C1 for work |
Provisioning operations
| Term | Definition |
|---|---|
| Grant (operation) | Operation to add an entitlement to a principal |
| Revoke | Operation to remove an entitlement from a principal |
| CreateAccount | JIT provisioning - create user account in target system |
| DeleteResource | Remove a resource from the target system |
| ResourceProvisionerV2 | SDK interface for Grant/Revoke operations (recommended) |
| AccountManagerV2 | SDK interface for CreateAccount operations (AccountManager is the older form) |
| ResourceDeleterV2 | SDK interface for Delete operations |
| Capability Manifest | JSON file (baton_capabilities.json) declaring supported operations |
Integration concepts
| Term | Definition |
|---|---|
| Sync | Reading access data from a system into C1; produces .c1z file |
| Provision | Writing access changes back to a system (grant, revoke, create, delete) |
| Reconciliation | Comparing actual access (from sync) to desired access (from policy) and correcting drift |
| JIT Provisioning | Just-In-Time provisioning - creating user account when first needed, not before |
| IdP | Identity Provider - authoritative source of user identities (Okta, Azure AD, Google Workspace) |
| Source of Truth | The system that authoritatively defines an entity (IdPs are typically source of truth for users) |
| Access Review | Process of verifying that existing access grants are still appropriate |
| Drift | Difference between actual access state and desired access state |
Pagination
| Term | Definition |
|---|---|
| Cursor-based pagination | Pagination using opaque tokens returned by the API |
| Offset-based pagination | Pagination using numeric offset and limit parameters |
| Page token | String passed between calls to continue pagination |
| LDAP paging | Server-side pagination for LDAP using cookies |
| Nested pagination | Paginating children within each paginated parent (managed with Bag) |
| Restart action | Error a connector returns when the API rejects a page token, so the SDK restarts the call at a page token you choose |
Authentication
| Term | Definition |
|---|---|
| API Key | Simple token-based authentication passed in headers |
| Bearer Token | Token passed in the Authorization header as Bearer {token} |
| OAuth2 Client Credentials | Flow exchanging client ID/secret for access token |
| JWT Service Account | Authentication using signed JSON Web Tokens (common for Google APIs) |
| LDAP Bind | Authentication to LDAP server using credentials |
| Domain-wide Delegation | Google pattern allowing service account to impersonate domain users |
Configuration
| Term | Definition |
|---|---|
| CEL | Common Expression Language - used for data transformation in meta-connectors |
| Environment variable | Configuration via BATON_* prefixed env vars |
| Configuration field | A setting declared with field.StringField and its siblings in pkg/config. The SDK turns each field into a flag, an environment variable, and a field on the generated configuration struct |
Development
| Term | Definition |
|---|---|
| golangci-lint | Standard Go linter used for connector code quality |
| Makefile targets | Typical connector targets: build, generate, test, lint, update-deps |
| Baton Starter Pack | GitHub template repository that creates a new connector project |