> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Enterprise Server User Provisioning & Deprovisioning

> Automate GitHub Enterprise Server user provisioning and deprovisioning from your HRIS. Klef creates, updates, and deactivates accounts when HR makes a change.

![](https://mintcdn.com/klef/0yi0WxAEtlskZwn-/images/connectors/github-enterprise-server.svg?fit=max\&auto=format\&n=0yi0WxAEtlskZwn-\&q=85\&s=907e0e3ae51e7d6a862ac2867088e23d)

# GitHub Enterprise Server

## Connection

### Setup

An organization owner connects GitHub Enterprise Server, or an organization on GHE.com, with a
classic personal access token that carries the **admin:org** and **repo** scopes. Klef's GitHub App
is installed on GitHub.com alone, so a server or GHE.com organization is reached with the owner's
token instead.

Klef adds each person to the organization by their username on the instance, which the policy maps.
GitHub may hold them as invited until they accept, and Klef gives them teams, repositories, and
organization roles once they join.

### Settings

| Setting | Required | Description |
| - | - | - |
| Instance URL | Yes | Address you open GitHub at, such as [https://github.example.com](https://github.example.com), or [https://acme.ghe.com](https://acme.ghe.com) on GHE.com. |
| Organization | Yes | The organization's name, as in [https://github.example.com/acme](https://github.example.com/acme). |
| Access token | Yes | Classic token of an organization owner with the admin:org and repo scopes. |

## github\_enterprise\_server.member

### Fields

| Field | Type | Required | Description |
| - | - | - | - |
| `email` | string | | Address an existing member is adopted by, which a member reads with when the organization signs in through its own SAML provider. Never changed once the account exists. |
| `login` (Username) | string, up to 39 | Yes | The person's username on the instance, which the connector adds them to the organization by. Never changed once the account exists. |
| `role` | enum | | Role in the organization. Defaults to member. Values: `member` (Member), `admin` (Owner). |
| `teams` | entitlements | | Teams the member belongs to. A team written on its own is held as a member. One row grants one team. |
| `teams[].team` | string | Yes | Team slug. |
| `teams[].role` | enum | | Role on the team. Defaults to member. Values: `member` (Member), `maintainer` (Maintainer). |
| `repositories` | entitlements | | Repositories the member is given access to directly. A repository written on its own is given read access. One row grants one repository. |
| `repositories[].repository` | string | Yes | Repository name. |
| `repositories[].permission` (Access) | enum | | Access to the repository. Defaults to read. Values: `pull` (Read), `triage` (Triage), `push` (Write), `maintain` (Maintain), `admin` (Admin). |
| `organizationRoles` | entitlements | | Organization roles the member is given directly, built in or custom. One row grants one role. |
| `organizationRoles[]` | string | | Organization role ID. |
| `status` | enum | | Whether the person can sign in, the account is kept switched off, or the account is gone. Values: `enabled` (Enabled), `removed` (Removed). |

### Default Account Matching Rules

When Klef [adopts](https://klef.ai/docs/adoption.md) an account that already exists in GitHub Enterprise Server, it works out whose it is by trying these in order. A connection can override them.

| Account field | Worker field |
| - | - |
| `email` | `worker.business_email` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.