LDAP の REST API エンドポイント
REST API を使用して、 GitHub Enterprise Server ユーザーまたはチームとそのリンクされた LDAP エントリ間のアカウント関係を更新するか、新しい同期をキューに入れます。
LDAP について
これらのエンドポイントを使って、ユーザーまたはチームがマップされる識別名 (DN) を更新できます。 ほとんどの場合、 アプライアンスで GitHub Enterprise Server必要があります。 LDAP 同期が無効になっている場合でも、LDAP が有効になっている場合は、ユーザーの LDAP マッピングの更新エンドポイントを使用できます。
メモ
これらのエンドポイントでは、personal access token (classic) を使う認証のみがサポートされます。 詳しくは、「個人用アクセス トークンを管理する」をご覧ください。
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.
"Update LDAP mapping for a team" のきめ細かいアクセス トークン
このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。
"Update LDAP mapping for a team" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
team_id integer 必須The unique identifier of the team. |
| 名前, タイプ, 説明 |
|---|
ldap_dn string 必須The distinguished name (DN) of the LDAP entry to map to a team. |
"Update LDAP mapping for a team" の HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
200 | OK |
"Update LDAP mapping for a team" のコード サンプル
要求の例
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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.
"Sync LDAP mapping for a team" のきめ細かいアクセス トークン
このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。
"Sync LDAP mapping for a team" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
team_id integer 必須The unique identifier of the team. |
"Sync LDAP mapping for a team" の HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
201 | Created |
"Sync LDAP mapping for a team" のコード サンプル
要求の例
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
http(s)://HOSTNAME/api/v3/admin/ldap/teams/TEAM_ID/syncResponse
Status: 201{
"status": "queued"
}Update LDAP mapping for a user
"Update LDAP mapping for a user" のきめ細かいアクセス トークン
このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。
"Update LDAP mapping for a user" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
username string 必須The handle for the GitHub user account. |
| 名前, タイプ, 説明 |
|---|
ldap_dn string 必須The distinguished name (DN) of the LDAP entry to map to a team. |
"Update LDAP mapping for a user" の HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
200 | OK |
"Update LDAP mapping for a user" のコード サンプル
要求の例
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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": "[email protected]",
"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.
"Sync LDAP mapping for a user" のきめ細かいアクセス トークン
このエンドポイントは、GitHubアプリ ユーザー アクセス トークン、GitHub アプリ インストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。
"Sync LDAP mapping for a user" のパラメーター
| 名前, タイプ, 説明 |
|---|
accept string Setting to |
| 名前, タイプ, 説明 |
|---|
username string 必須The handle for the GitHub user account. |
"Sync LDAP mapping for a user" の HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
201 | Created |
"Sync LDAP mapping for a user" のコード サンプル
要求の例
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
http(s)://HOSTNAME/api/v3/admin/ldap/users/USERNAME/syncResponse
Status: 201{
"status": "queued"
}