Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions baton/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Set up a GitHub connector"
og:title: "Set up a GitHub connector"
description: "C1 provides identity governance and just-in-time provisioning for GitHub. Integrate your GitHub instance with C1 to run user access reviews (UARs), enable just-in-time access requests, and automatically provision and deprovision access."
og:description: "C1 provides identity governance and just-in-time provisioning for GitHub. Integrate your GitHub instance with C1 to run user access reviews (UARs), enable just-in-time access requests, and automatically provision and deprovision access."

Check warning on line 5 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L5

Did you really mean 'UARs'?

Check warning on line 5 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L5

Did you really mean 'deprovision'?
sidebarTitle: "GitHub"
---

Expand All @@ -19,7 +19,7 @@
| Accounts | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Repositories | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Teams | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Orgs | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |

Check warning on line 22 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L22

Did you really mean 'Orgs'?
| GitHub Apps (NHI) | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |
| Secrets - API keys | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |

Expand Down Expand Up @@ -71,7 +71,7 @@
- **user** - select all

<Warning>
The **write::org** scope is used by C1 when automatically provisioning and deprovisioning GitHub access on your behalf. **If you do not want C1 to perform these tasks for you, do not give your token this scope.**

Check warning on line 74 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L74

Did you really mean 'deprovisioning'?
</Warning>
</Step>
<Step>
Expand Down Expand Up @@ -182,7 +182,7 @@
Check the **Expire user authorization tokens** and **Enable Device Flow** checkboxes to enable these settings.
</Step>
<Step>
In the **Webhook** section of the page, uncheck the **Active** checkbox to disable this setting.

Check warning on line 185 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L185

Did you really mean 'uncheck'?
</Step>
<Step>
In the **Permissions** section of the page, give the app the following permissions:
Expand Down Expand Up @@ -257,7 +257,7 @@
<Step>
Choose how to set up the new GitHub 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 C1)

Check warning on line 260 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L260

Did you really mean 'unmanaged'?

* Add the connector to a managed app (select from the list of existing managed apps)

Expand Down Expand Up @@ -300,7 +300,7 @@

1. **Optional.** Click to enable **Sync secrets**. [Synced secrets](/product/admin/inventory) are displayed on the **Inventory** page.

1. **Optional.** If you do not want to include archived repos in syncs, click to enable **Omit archived repositories**.

Check warning on line 303 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L303

Did you really mean 'repos'?

1. **Optional.** If your GitHub organization has thousands of repositories or members, click to enable **Optimize sync for large organizations**. See [Optimize sync for large organizations](#optimize-sync-for-large-organizations) for what changes when this option is enabled.
</Step>
Expand Down Expand Up @@ -338,7 +338,7 @@
<Step>
Choose how to set up the new GitHub 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 C1)

Check warning on line 341 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L341

Did you really mean 'unmanaged'?

* Add the connector to a managed app (select from the list of existing managed apps)

Expand Down Expand Up @@ -390,14 +390,14 @@
BATON_ORGS: <Name of the single GitHib org the app was created for>

# Optional: include if you want C1 to provision access using this connector
BATON_PROVISIONING: true
BATON_PROVISIONING: "true"

# Optional: include if you do not want to sync archived repos
BATON_OMIT_ARCHIVED_REPOSITORIES: true
BATON_OMIT_ARCHIVED_REPOSITORIES: "true"

# Optional: enable for orgs with thousands of repos or members to reduce sync time.
# See "Optimize sync for large organizations" below for trade-offs.
BATON_DIRECT_COLLABORATORS_ONLY: true
BATON_DIRECT_COLLABORATORS_ONLY: "true"

---
# baton-github-app-key-secret.yaml
Expand Down Expand Up @@ -433,7 +433,7 @@
metadata:
labels:
app: baton-github
baton: true
baton: "true"
baton-app: github
spec:
containers:
Expand Down Expand Up @@ -462,7 +462,7 @@

<Steps>
<Step>
Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

Check warning on line 465 in baton/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/github.mdx#L465

Did you really mean 'namespace'?
</Step>
<Step>
Check that the connector data uploaded correctly. In C1, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the GitHub connector to. GitHub data should be found on the **Entitlements** and **Accounts** tabs.
Expand Down