Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para LDAP

Utiliza la API de REST para actualizar las relaciones de cuenta entre un usuario de GitHub Enterprise Server o un equipo y su entrada enlazada de LDAP o para poner en cola una sincronización nueva.

Acerca de LDAP

Puede utilizar estos puntos de conexión para actualizar el nombre distintivo (DN) al cual mapea un usuario o equipo. Ten en cuenta que, en la mayoría de los casos, debes tener habilitada la sincronización LDAP para el dispositivo de GitHub Enterprise Server. La Actualización de la asignación LDAP para un punto de conexión de usuario se puede usar cuando LDAP está habilitado, incluso si la sincronización LDAP está deshabilitada.

Note

Estos puntos de conexión solo admiten la autenticación mediante personal access token (classic). Para obtener más información, vea «Administración de tokens de acceso personal».

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.

Tokens de acceso específicos para "Update LDAP mapping for a team"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Update LDAP mapping for a team"

Encabezados
accept string

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

Parámetros de la ruta de acceso
team_id integer Requerido

The unique identifier of the team.

Parámetros del cuerpo
ldap_dn string Requerido

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

Códigos de estado de respuesta HTTP para "Update LDAP mapping for a team"

status codeDescripción
200

OK

Ejemplos de código para "Update LDAP mapping for a team"

Ejemplo de solicitud

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.

Tokens de acceso específicos para "Sync LDAP mapping for a team"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Sync LDAP mapping for a team"

Encabezados
accept string

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

Parámetros de la ruta de acceso
team_id integer Requerido

The unique identifier of the team.

Códigos de estado de respuesta HTTP para "Sync LDAP mapping for a team"

status codeDescripción
201

Created

Ejemplos de código para "Sync LDAP mapping for a team"

Ejemplo de solicitud

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

Tokens de acceso específicos para "Update LDAP mapping for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Update LDAP mapping for a user"

Encabezados
accept string

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

Parámetros de la ruta de acceso
username string Requerido

The handle for the GitHub user account.

Parámetros del cuerpo
ldap_dn string Requerido

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

Códigos de estado de respuesta HTTP para "Update LDAP mapping for a user"

status codeDescripción
200

OK

Ejemplos de código para "Update LDAP mapping for a user"

Ejemplo de solicitud

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.

Tokens de acceso específicos para "Sync LDAP mapping for a user"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Sync LDAP mapping for a user"

Encabezados
accept string

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

Parámetros de la ruta de acceso
username string Requerido

The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Sync LDAP mapping for a user"

status codeDescripción
201

Created

Ejemplos de código para "Sync LDAP mapping for a user"

Ejemplo de solicitud

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" }