Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-09-25. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für LDAP

Verwende die REST-API, um Kontobeziehungen zwischen einem GitHub Enterprise Server-Benutzer oder -Team und dem zugehörigen verknüpften LDAP-Eintrag zu aktualisieren oder eine neue Synchronisierung in die Warteschlange einzureihen.

Informationen zu LDAP

Du kannst diese Endpunkte verwenden, um den Distinguished Name (DN) zu aktualisieren, dem ein Benutzer oder Team zugeordnet ist. Beachte, dass für deine GitHub Enterprise Server-Appliance in den meisten Fällen die LDAP-Synchronisierung aktiviert sein muss. Die Update-LDAP-Zuordnung für einen Benutzerendpunkt kann verwendet werden, wenn LDAP aktiviert ist, auch wenn die LDAP-Synchronisierung deaktiviert ist.

Note

Diese Endpunkte unterstützen nur die Authentifizierung über ein personal access token (classic). Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken.

Update LDAP mapping for a team

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

Differenzierte Zugriffstoken für "Update LDAP mapping for a team"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Update LDAP mapping for a team“

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
team_id integer Erforderlich

The unique identifier of the team.

Textparameter
ldap_dn string Erforderlich

The distinguished name (DN) of the LDAP entry to map to a team.

HTTP-Antwortstatuscodes für „Update LDAP mapping for a team“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Update LDAP mapping for a team“

Anforderungsbeispiel

patch/admin/ldap/teams/{team_id}/mapping
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/admin/ldap/teams/TEAM_ID/mapping \ -d '{"ldap_dn":"cn=Enterprise Ops,ou=teams,dc=github,dc=com"}'

Response

Status: 200
{ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com", "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://HOSTNAME/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://HOSTNAME/teams/1/members{/member}", "repositories_url": "https://HOSTNAME/teams/1/repos", "parent": null }

Sync LDAP mapping for a team

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

Differenzierte Zugriffstoken für "Sync LDAP mapping for a team"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Sync LDAP mapping for a team“

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
team_id integer Erforderlich

The unique identifier of the team.

HTTP-Antwortstatuscodes für „Sync LDAP mapping for a team“

StatuscodeBESCHREIBUNG
201

Created

Codebeispiele für „Sync LDAP mapping for a team“

Anforderungsbeispiel

post/admin/ldap/teams/{team_id}/sync
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/admin/ldap/teams/TEAM_ID/sync

Response

Status: 201
{ "status": "queued" }

Update LDAP mapping for a user

Differenzierte Zugriffstoken für "Update LDAP mapping for a user"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Update LDAP mapping for a user“

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
username string Erforderlich

The handle for the GitHub user account.

Textparameter
ldap_dn string Erforderlich

The distinguished name (DN) of the LDAP entry to map to a team.

HTTP-Antwortstatuscodes für „Update LDAP mapping for a user“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Update LDAP mapping for a user“

Anforderungsbeispiel

patch/admin/ldap/users/{username}/mapping
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/admin/ldap/users/USERNAME/mapping \ -d '{"ldap_dn":"uid=asdf,ou=users,dc=github,dc=com"}'

Response

Status: 200
{ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com", "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false, "name": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } }

Sync LDAP mapping for a user

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

Differenzierte Zugriffstoken für "Sync LDAP mapping for a user"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

Parameter für „Sync LDAP mapping for a user“

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
username string Erforderlich

The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Sync LDAP mapping for a user“

StatuscodeBESCHREIBUNG
201

Created

Codebeispiele für „Sync LDAP mapping for a user“

Anforderungsbeispiel

post/admin/ldap/users/{username}/sync
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/admin/ldap/users/USERNAME/sync

Response

Status: 201
{ "status": "queued" }