diff --git a/baton/_release-notes.mdx b/baton/_release-notes.mdx index d7c1285..0bc6829 100644 --- a/baton/_release-notes.mdx +++ b/baton/_release-notes.mdx @@ -3,6 +3,7 @@ title: "Connector release notes" sidebarTitle: "Release notes" description: "Here you'll find the latest on new connectors, connector updates, and other connector news from C1." --- +{/* OpenAI */} ### New connectors diff --git a/baton/intro.mdx b/baton/intro.mdx index 71be224..5e31786 100644 --- a/baton/intro.mdx +++ b/baton/intro.mdx @@ -69,7 +69,6 @@ You can build it yourself, or we can build it for you. Whether it’s API-based, - - [1Password](/baton/1password) - [7shifts](/baton/sevenshifts) - [15Five](/baton/fifteenfive) @@ -189,7 +188,8 @@ You can build it yourself, or we can build it for you. Whether it’s API-based, - [Okta](/baton/okta-v2) - [Okta AWS Federation](/baton/okta-aws-federation) - [Okta CIAM Workforce](/baton/okta-ciam-workforce) - - [OneLogin](/baton/onelogin-v2) + - [OneLogin](/baton/onelogin-v2) + - [OpenAI](/baton/openai) - [OpenSearch](/baton/opensearch) - [Oracle Cloud Infrastructure](/baton/oracle-cloud-infrastructure) - [Oracle Field Service](/baton/oracle-field-service) @@ -270,6 +270,8 @@ You can build it yourself, or we can build it for you. Whether it’s API-based, +- [OpenAI](/baton/openai) + - [Valimail](/baton/valimail) - [ZipHQ](/baton/ziphq) - [PrisimHR](/baton/prismhr) @@ -312,6 +314,7 @@ You can build it yourself, or we can build it for you. Whether it’s API-based, - [Miro](/baton/miro) - [Monday.com](/baton/monday) - [Notion](/baton/notion) +- [OpenAI](/baton/openai) - [Procore](/baton/procore) - [Slack](/baton/slack) - [Slack Enterprise Grid](/baton/slack-enterprise) diff --git a/baton/openai.mdx b/baton/openai.mdx new file mode 100644 index 0000000..4e77fcc --- /dev/null +++ b/baton/openai.mdx @@ -0,0 +1,203 @@ +--- +title: "Set up OpenAI connector" +og:title: "Set up OpenAI connector" +description: "ConductorOne provides identity governance and just-in-time provisioning for OpenAI. Integrate your OpenAI instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests." +og:description: "ConductorOne provides identity governance and just-in-time provisioning for OpenAI. Integrate your OpenAI instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests." +sidebarTitle: "OpenAI" +--- + + +**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. + +We recommend closely monitoring workflows that use this connector and contacting our Support team with any issues or feedback. + + +## Capabilities + +| Resource | Sync | Provision | +| :--- | :--- | :--- | +| Account | | | +| Invitation | | | +| Organization role | | | +| Project | | | +| API key | | | + +**Additional functionality:** + + Supports [automatic account provisioning and deprovisioning](/product/admin/account-provisioning)
+ +## Gather OpenAI configuration information + +Configuring the connector requires you to pass in information from OpenAI. Gather these configuration details before you move on. + +Here's the information you'll need: + +- OpenAI Admin Key + +See the OpenAI docs for information on how to acquire credentials: [View the documentation](https://platform.openai.com/docs/api-reference/administration) + +## Configure the OpenAI connector + + +To complete this task, you'll need: + +- The **Connector Administrator** or **Super Administrator** role in ConductorOne +- Access to the set of OpenAI configuration information gathered by following the instructions above + + + + + +**Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.** + + + + In ConductorOne, navigate to **Admin** > **Connectors** and click **Add connector**. + + + Search for **OpenAI** and click **Add**. + + + Choose how to set up the new OpenAI 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**. + + + Enter the configuration information from the previous section. + + + 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 OpenAI connector is now pulling access data into ConductorOne. + + + + +**Follow these instructions to use the OpenAI connector, hosted and run in your own environment.** + +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. + +### Step 1: Set up a new OpenAI connector + + + + In ConductorOne, navigate to **Connectors** > **Add connector**. + + + Search for **Baton** and click **Add**. + + + Choose how to set up the new OpenAI 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 OpenAI connector deployment: + +#### Secrets configuration + +```yaml +# baton-openai-secrets.yaml +apiVersion: v1 +kind: Secret +metadata: + name: baton-openai-secrets +type: Opaque +stringData: + # ConductorOne credentials + BATON_CLIENT_ID: + BATON_CLIENT_SECRET: + + # OpenAI config + BATON_OPENAI_ADMIN_KEY: + + # 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 + +```yaml expandable +# baton-openai.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: baton-openai + labels: + app: baton-openai +spec: + selector: + matchLabels: + app: baton-openai + template: + metadata: + labels: + app: baton-openai + baton: true + baton-app: openai + spec: + containers: + - name: baton-openai + image: ghcr.io/conductorone/baton-openai:latest + imagePullPolicy: IfNotPresent + env: + - name: BATON_HOST_ID + value: baton-openai + envFrom: + - secretRef: + name: baton-openai-secrets +``` + +### Step 3: Deploy the connector + + + + Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files. + + + 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 OpenAI connector to. OpenAI data should be found on the **Entitlements** and **Accounts** tabs. + + + +**That's it!** Your OpenAI connector is now pulling access data into ConductorOne. + + + + + diff --git a/docs.json b/docs.json index f498c9a..3933f21 100644 --- a/docs.json +++ b/docs.json @@ -362,6 +362,7 @@ "baton/okta-aws-federation", "baton/okta-ciam-workforce", "baton/onelogin-v2", + "baton/openai", "baton/opensearch", "baton/oracle-cloud-infrastructure", "baton/oracle-field-service",