Skip to content

Commit d8e894b

Browse files
author
baton-admin[bot]
committed
docs: seed connector documentation from ConductorOne/docs
1 parent af634d1 commit d8e894b

File tree

1 file changed

+231
-0
lines changed

1 file changed

+231
-0
lines changed

‎docs/connector.mdx‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
---
2+
title: "Set up a Celigo connector"
3+
og:title: "Set up a Celigo connector"
4+
description: "ConductorOne provides identity governance and just-in-time provisioning for Celigo. Integrate your Celigo instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
5+
og:description: "ConductorOne provides identity governance and just-in-time provisioning for Celigo. Integrate your Celigo instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
6+
sidebarTitle: "Celigo"
7+
---
8+
9+
## Capabilities
10+
11+
| Resource | Sync | Provision |
12+
| :--- | :--- | :--- |
13+
| Accounts | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
14+
| Integrations | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
15+
| Roles | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | <Icon icon="square-check" iconType="solid" color="#65DE23"/> |
16+
17+
## Gather Celigo credentials
18+
19+
Configuring the connector requires you to pass in credentials generated in Celigo. Gather these credentials before you move on.
20+
21+
<Warning>
22+
A user with the **Account owner** or **Administrator** role in Celigo must perform this task.
23+
</Warning>
24+
25+
### Generate a Celigo API token
26+
27+
<Steps>
28+
<Step>
29+
In Celigo, navigate to **Resources** > **API tokens**.
30+
</Step>
31+
<Step>
32+
Click **Create API token**.
33+
</Step>
34+
<Step>
35+
Give the new API token a name, such as "ConductorOne integration".
36+
</Step>
37+
<Step>
38+
In the **Auto purge token** field, select a lifetime for the token.
39+
</Step>
40+
<Step>
41+
Set the token's scope to **Full access**.
42+
</Step>
43+
<Step>
44+
Click **Save & close**.
45+
</Step>
46+
<Step>
47+
The new token is shown on the **API tokens** page. Click **Show token** to view the full token value.
48+
</Step>
49+
<Step>
50+
Carefully and copy and save the new API token.
51+
</Step>
52+
</Steps>
53+
54+
**That's it!** Next, move on to the connector configuration instructions.
55+
56+
## Configure the Celigo connector
57+
58+
<Warning>
59+
To complete this task, you'll need:
60+
61+
- The **Connector Administrator** or **Super Administrator** role in ConductorOne
62+
- Access to the set of Celigo credentials generated by following the instructions above
63+
</Warning>
64+
65+
<Tabs>
66+
<Tab title="Cloud-hosted">
67+
68+
**Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.**
69+
70+
<Steps>
71+
<Step>
72+
In ConductorOne, navigate to **Integrations** > **Connectors** and click **Add connector**.
73+
</Step>
74+
<Step>
75+
Search for **Celigo** and click **Add**.
76+
</Step>
77+
<Step>
78+
Choose how to set up the new Celigo connector:
79+
- 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)
80+
- Add the connector to a managed app (select from the list of existing managed apps)
81+
- Create a new managed app
82+
</Step>
83+
<Step>
84+
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.
85+
86+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
87+
</Step>
88+
<Step>
89+
Click **Next**.
90+
</Step>
91+
<Step>
92+
Find the **Settings** area of the page and click **Edit**.
93+
</Step>
94+
<Step>
95+
Select your Celigo region (United States or European Union).
96+
</Step>
97+
<Step>
98+
Paste the API token you generated in Step 1 into the **Access token** field.
99+
</Step>
100+
<Step>
101+
Click **Save**.
102+
</Step>
103+
<Step>
104+
The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
105+
</Step>
106+
</Steps>
107+
108+
**That's it!** Your Celigo connector is now pulling access data into ConductorOne.
109+
110+
</Tab>
111+
<Tab title="Self-hosted">
112+
113+
**Follow these instructions to use the Celigo connector, hosted and run in your own environment.**
114+
115+
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.
116+
117+
### Resources
118+
119+
* [GitHub repository](https://github.com/ConductorOne/baton-celigo): Access the source code, report issues, or contribute to the project.
120+
121+
### Step 1: Set up a new Celigo connector
122+
123+
<Steps>
124+
<Step>
125+
In ConductorOne, navigate to **Integrations** > **Connectors** > **Add connector**.
126+
</Step>
127+
<Step>
128+
Search for **Baton** and click **Add**.
129+
</Step>
130+
<Step>
131+
Choose how to set up the new Celigo connector:
132+
- 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)
133+
- Add the connector to a managed app (select from the list of existing managed apps)
134+
- Create a new managed app
135+
</Step>
136+
<Step>
137+
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.
138+
139+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
140+
</Step>
141+
<Step>
142+
Click **Next**.
143+
</Step>
144+
<Step>
145+
In the **Settings** area of the page, click **Edit**.
146+
</Step>
147+
<Step>
148+
Click **Rotate** to generate a new Client ID and Secret.
149+
150+
Carefully copy and save these credentials. We'll use them in Step 2.
151+
</Step>
152+
</Steps>
153+
154+
### Step 2: Create Kubernetes configuration files
155+
156+
Create two Kubernetes manifest files for your Celigo connector deployment:
157+
158+
#### Secrets configuration
159+
160+
```yaml expandable
161+
# baton-celigo-secrets.yaml
162+
apiVersion: v1
163+
kind: Secret
164+
metadata:
165+
name: baton-celigo-secrets
166+
type: Opaque
167+
stringData:
168+
# ConductorOne credentials
169+
BATON_CLIENT_ID: <ConductorOne client ID>
170+
BATON_CLIENT_SECRET: <ConductorOne client secret>
171+
172+
# Celigo credentials
173+
BATON_CELIGO_ACCESS_TOKEN: <API access token generated for this integration>
174+
BATON_REGION: <Your Celigo region (default "us")>
175+
176+
# Optional: include if you want ConductorOne to provision access using this connector
177+
BATON_PROVISIONING: true
178+
```
179+
180+
See the connector's README or run `--help` to see all available configuration flags and environment variables.
181+
182+
#### Deployment configuration
183+
184+
```yaml expandable
185+
# baton-celigo.yaml
186+
apiVersion: apps/v1
187+
kind: Deployment
188+
metadata:
189+
name: baton-celigo
190+
labels:
191+
app: baton-celigo
192+
spec:
193+
selector:
194+
matchLabels:
195+
app: baton-celigo
196+
template:
197+
metadata:
198+
labels:
199+
app: baton-celigo
200+
baton: true
201+
baton-app: celigo
202+
spec:
203+
containers:
204+
- name: baton-celigo
205+
image: ghcr.io/conductorone/baton-celigo:latest
206+
imagePullPolicy: IfNotPresent
207+
env:
208+
- name: BATON_HOST_ID
209+
value: baton-celigo
210+
envFrom:
211+
- secretRef:
212+
name: baton-celigo-secrets
213+
```
214+
215+
### Step 3: Deploy the connector
216+
217+
<Steps>
218+
<Step>
219+
Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
220+
</Step>
221+
<Step>
222+
Check that the connector data uploaded correctly. In ConductorOne, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the Celigo connector to. Celigo data should be found on the **Entitlements** and **Accounts** tabs.
223+
</Step>
224+
</Steps>
225+
226+
**That's it!** Your Celigo connector is now pulling access data into ConductorOne.
227+
228+
</Tab>
229+
</Tabs>
230+
231+

0 commit comments

Comments
 (0)