Set up a Segment connector
Capabilities
Resource | Sync | Provision |
---|---|---|
Accounts | ✅ | |
Groups | ✅ | ✅ |
Resources | ✅ | |
Roles | ✅ | |
Workspaces | ✅ |
Available hosting methods
Choose the hosting method that best suits your needs:
Method | Availability | Notes |
---|---|---|
Cloud hosted | ✅ | A built-in, no-code connector hosted by ConductorOne. |
Self-hosted | ✅ | The Segment connector, hosted and run in your own environment. |
Gather Segment credentials
Each setup method requires you to pass in credentials generated in Segment. Gather these credentials before you move on.
A user with the Workspace Owner role in the Segment workspace must perform this task.
Generate an API token
In Segment, click Settings.
On the Workspace Settings page, click Access Management.
Click the Tokens tab and click + Create Token.
Give the new token a name, such as “ConductorOne”.
Assign the token the Workspace Owner access level.
This access level is required to read information about groups, resources, and roles in the workspace.
Click Create.
Carefully copy and save the new token.
That’s it! Next, move on to the instructions for your chosen setup method.
Set up a Segment cloud-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of Segment credentials generated by following the instructions above
In ConductorOne, click Connectors > Add connector.
Search for Segment and click Add.
Choose how to set up the new Segment connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
Find the Settings area of the page and click Edit.
Paste the API token into the API token field.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
That’s it! Your Segment connector is now pulling access data into ConductorOne.
Set up a Segment cloud-hosted connector using Terraform
As an alternative to the cloud-hosted setup process described above, you can use Terraform to configure the integration between Segment and ConductorOne.
See the ConductorOne Segment integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.
Set up a Segment self-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of Segment credentials generated by following the instructions above
When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.
Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.
Step 1: Configure the Segment connector
In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Segment connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
In the Settings area of the page, click Edit.
Click Rotate to generate a new Client ID and Secret.
Carefully copy and save these credentials. We’ll use them in Step 2.
Step 2: Create Kubernetes configuration files
Create two Kubernetes manifest files for your Segment connector deployment:
Secrets configuration
# baton-segment-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: baton-segment-secrets
type: Opaque
stringData:
# ConductorOne credentials
BATON_CLIENT_ID: <ConductorOne client ID>
BATON_CLIENT_SECRET: <ConductorOne client secret>
# Segment credentials
BATON_TOKEN: <Segment API token>
# Optional: include if you want ConductorOne to provision access using this connector
BATON_PROVISIONING: true
See the connector’s README or run
--help
to see all available configuration flags and environment variables.
Deployment configuration
# baton-segment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: baton-segment
labels:
app: baton-segment
spec:
selector:
matchLabels:
app: baton-segment
template:
metadata:
labels:
app: baton-segment
baton: true
baton-app: segment
spec:
containers:
- name: baton-segment
image: ghcr.io/conductorone/baton-segment:latest
args: ["service"]
imagePullPolicy: IfNotPresent
envFrom:
- secretRef:
name: baton-segment-secrets
Step 3: Deploy the connector
Create a namespace in which to run ConductorOne connectors (if desired):
kubectl create namespace baton-segment
Apply the secret configuration:
kubectl -n baton-segment apply -f baton-segment-secrets.yaml
Apply the deployment:
kubectl -n baton-segment apply -f baton-segment.yaml
Step 4: Verify the deployment
Check that the deployment is running:
kubectl -n c1 get pods
View the connector logs:
kubectl -n c1 logs -l app=baton-${baton-segment}
Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the Segment connector to. Segment data should be found on the Entitlements and Accounts tabs.
That’s it! Your Segment connector is now pulling access data into ConductorOne.