Targets
GitHub Enterprise
Was this page helpful?
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
| Setting | Required | Description |
|---|---|---|
| Enterprise | Yes | Enterprise slug, as in github.com/enterprises/acme-inc. |
| GHE.com API URL | API address of an enterprise on GHE.com. Leave empty for GitHub.com. | |
| Access token | Yes | Classic token with the scim:enterprise scope, created by the enterprise’s setup user. Stored encrypted. |
| Capability | Required | Granted by (any one) |
|---|---|---|
| Provision users | Yes | scim:enterprise |
| Read groups | Yes | scim:enterprise |
| Field | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | User name the identity provider signs the person in with, usually their email address. |
externalId (Identity provider ID) | reference, user | Yes | The identity provider’s ID for the person. Cannot change once the account exists. Names the account rather than describing it, so a diff leaves it out. |
displayName | string | Yes | Full name shown on GitHub. |
givenName | string | Yes | First name. |
familyName | string | Yes | Last name. |
email | string | Yes | Primary email address. |
active | bool | Whether the account is active. An inactive account is suspended, never deleted. | |
groups | grant | Enterprise groups the user belongs to. A group can be linked to organization teams. One row grants one group. | |
groups[] | string | Group ID. |
| Account field | Worker field |
|---|---|
userName | worker.business_email |
stage active {
target github_enterprise.user {
userName = worker.business_email
externalId = lookup(table.idp_user_ids, worker.business_email)
displayName = worker.display_name
givenName = worker.legal_name.given
familyName = worker.legal_name.family
email = worker.business_email
active = true
groups = ["Engineering"]
}
}
Was this page helpful?