Skip to content

Commit 7b6a7d1

Browse files
author
baton-admin[bot]
committed
docs: seed connector documentation from ConductorOne/docs
1 parent 01bdb21 commit 7b6a7d1

File tree

1 file changed

+252
-0
lines changed

1 file changed

+252
-0
lines changed

‎docs/connector.mdx‎

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
---
2+
title: Set up a PrivX connector
3+
og:title: Set up a PrivX connector - ConductorOne docs
4+
og:description: Integrate your PrivX Enterprise instance with ConductorOne to run user access reviews, enable just-in-time access requests, and easily provision and deprovision access.
5+
description: ConductorOne provides identity governance and just-in-time provisioning for PrivX. Integrate your PrivX Enterprise instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests.
6+
sidebarTitle: PrivX
7+
---
8+
9+
<Warning>
10+
**This connector is in beta.** This means it's undergoing ongoing testing and development while we gather feedback, validate functionality, and improve stability. Beta connectors are generally stable, but they may have limited feature support, incomplete error handling, or occasional issues.
11+
12+
We recommend closely monitoring workflows that use this connector and contacting our Support team with any issues or feedback.
13+
</Warning>
14+
15+
## Capabilities
16+
17+
| Resource | Sync | Provision |
18+
| :----------- | :--- | :-------- |
19+
| Accounts | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
20+
| Roles | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
21+
22+
## Gather PrivX credentials
23+
24+
Configuring the connector requires you to pass in credentials generated in PrivX. Gather these credentials before you move on.
25+
26+
<Warning>
27+
A user with the **Admin** role in PrivX must perform this task.
28+
</Warning>
29+
30+
### Set up a PrivX role
31+
32+
First, create a PrivX role that will be used to grant permissions to the API client you'll use to integrate with ConductorOne.
33+
34+
<Steps>
35+
<Step>
36+
In PrivX, navigate to **Administration** > **Roles** and click **Add Role**.
37+
</Step>
38+
<Step>
39+
Create a new role (or locate an existing role) with the following permissions:
40+
- roles-view
41+
- users-view
42+
- role-target-resources-view
43+
</Step>
44+
<Step>
45+
Make a note of the name of the role.
46+
</Step>
47+
</Steps>
48+
49+
### Create a PrivX API client
50+
51+
<Steps>
52+
<Step>
53+
Still in PrivX, navigate to **Administration** > **Deployment** and click **Integrate with PrivX Using API Clients**.
54+
</Step>
55+
<Step>
56+
Click **Add API Client**.
57+
</Step>
58+
<Step>
59+
Give the new client a name and assign it the role you just created or identified.
60+
</Step>
61+
<Step>
62+
Click **Save**.
63+
</Step>
64+
<Step>
65+
Scroll down to the **Credentials** section of the page. Carefully copy and save the OAuth Client ID and Client Secret, and the API Client ID and Client Secret.
66+
</Step>
67+
</Steps>
68+
**That's it!** Next, move on to the connector configuration instructions.
69+
70+
## Configure the PrivX connector
71+
72+
<Warning>
73+
To complete this task, you'll need:
74+
75+
- The **Connector Administrator** or **Super Administrator** role in ConductorOne
76+
- Access to the set of PrivX credentials generated by following the instructions above
77+
</Warning>
78+
79+
<Tabs>
80+
<Tab title="Cloud-hosted">
81+
82+
**Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.**
83+
84+
<Steps>
85+
<Step>
86+
In ConductorOne, navigate to **Integrations** > **Connectors** and click **Add connector**.
87+
</Step>
88+
<Step>
89+
Search for **PrivX** and click **Add**.
90+
</Step>
91+
<Step>
92+
Choose how to set up the new PrivX connector:
93+
94+
* 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)
95+
96+
* Add the connector to a managed app (select from the list of existing managed apps)
97+
98+
* Create a new managed app
99+
</Step>
100+
<Step>
101+
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.
102+
103+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
104+
</Step>
105+
<Step>
106+
Click **Next**.
107+
</Step>
108+
<Step>
109+
Find the **Settings** area of the page and click **Edit**.
110+
</Step>
111+
<Step>
112+
Select your preferred authentication method, **OAuth** or **Client secret**:
113+
114+
- For **OAuth**, enter your PrivX base URL and paste in the OAuth credentials.
115+
116+
- For **Client secret**, enter your PrivX base URL and paste in the API client credentials.
117+
</Step>
118+
<Step>
119+
Click **Save**.
120+
</Step>
121+
<Step>
122+
The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
123+
</Step>
124+
</Steps>
125+
**That's it!** Your PrivX connector is now pulling access data into ConductorOne.
126+
</Tab>
127+
<Tab title="Self-hosted">
128+
129+
**Follow these instructions to use the Privx connector, hosted and run in your own environment.**
130+
131+
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.
132+
133+
### Resources
134+
135+
* [Official download center](https://dist.conductorone.com/ConductorOne/baton-privx): For stable binaries (Windows/Linux/macOS) and container images.
136+
137+
* [GitHub repository](https://github.com/ConductorOne/baton-privx): Access the source code, report issues, or contribute to the project.
138+
139+
### Step 1: Set up a new PrivX connector
140+
141+
<Steps>
142+
<Step>
143+
In ConductorOne, navigate to **Integrations** > **Connectors** > **Add connector**.
144+
</Step>
145+
<Step>
146+
Search for **Baton** and click **Add**.
147+
</Step>
148+
<Step>
149+
Choose how to set up the new PrivX connector:
150+
151+
* 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)
152+
153+
* Add the connector to a managed app (select from the list of existing managed apps)
154+
155+
* Create a new managed app
156+
</Step>
157+
<Step>
158+
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.
159+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
160+
</Step>
161+
<Step>
162+
Click **Next**.
163+
</Step>
164+
<Step>
165+
In the **Settings** area of the page, click **Edit**.
166+
</Step>
167+
<Step>
168+
Click **Rotate** to generate a new Client ID and Secret.
169+
Carefully copy and save these credentials. We'll use them in Step 2.
170+
</Step>
171+
</Steps>
172+
### Step 2: Create Kubernetes configuration files
173+
174+
Create two Kubernetes manifest files for your PrivX connector deployment:
175+
176+
#### Secrets configuration
177+
178+
```yaml
179+
# baton-privx-secrets.yaml
180+
apiVersion: v1
181+
kind: Secret
182+
metadata:
183+
name: baton-privx-secrets
184+
type: Opaque
185+
stringData:
186+
# ConductorOne credentials
187+
BATON_CLIENT_ID: <ConductorOne client ID>
188+
BATON_CLIENT_SECRET: <ConductorOne client secret>
189+
190+
# PrivX credentials, option 1
191+
BATON_API_CLIENT_ID: <PrivX API client ID>
192+
BATON_API_CLIENT_SECRET: <PrivX API client secret>
193+
BATON_BASE_URL: <PrivX instance base URL>
194+
195+
# PrivX credentials, option 2
196+
BATON_OAUTH_CLIENT_ID: <PrivX OAuth client ID>
197+
BATON_OAUTH_CLIENT_SECRET: <PrivX OAuth client secret>
198+
BATON_BASE_URL: <PrivX instance base URL>
199+
```
200+
201+
See the connector's README or run `--help` to see all available configuration flags and environment variables.
202+
203+
#### Deployment configuration
204+
205+
```yaml expandable
206+
# baton-privx.yaml
207+
apiVersion: apps/v1
208+
kind: Deployment
209+
metadata:
210+
name: baton-privx
211+
labels:
212+
app: baton-privx
213+
spec:
214+
selector:
215+
matchLabels:
216+
app: baton-privx
217+
template:
218+
metadata:
219+
labels:
220+
app: baton-privx
221+
baton: true
222+
baton-app: privx
223+
spec:
224+
containers:
225+
- name: baton-privx
226+
image: ghcr.io/conductorone/baton-privx:latest
227+
imagePullPolicy: IfNotPresent
228+
env:
229+
- name: BATON_HOST_ID
230+
value: baton-privx
231+
envFrom:
232+
- secretRef:
233+
name: baton-privx-secrets
234+
```
235+
236+
### Step 3: Deploy the connector
237+
238+
<Steps>
239+
<Step>
240+
Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
241+
</Step>
242+
<Step>
243+
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 PrivX connector to. PrivX data should be found on the **Entitlements** and **Accounts** tabs.
244+
</Step>
245+
</Steps>
246+
247+
**That's it!** Your PrivX connector is now pulling access data into ConductorOne.
248+
</Tab>
249+
</Tabs>
250+
251+
252+

0 commit comments

Comments
 (0)