Поддержка этой версии GitHub Enterprise была прекращена 2023-03-15. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию GitHub Enterprise. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.
Недавно мы перенесли некоторые из документации по REST API. Если вы не можете найти то, что ищете, попробуйте использовать страницу REST API Действия.
Пользователи
Используйте REST API для приостановки, отмены добавления, повышения и понижения пользователей на предприятии.
About user administration
These endpoints are only available to authenticated site administrators. Normal users will receive a 403
response.
List public keys
Параметры для "List public keys"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры запроса |
Имя, Тип, Описание |
per_page integer The number of results per page (max 100). По умолчанию: |
page integer Page number of the results to fetch. По умолчанию: |
direction string The direction to sort the results by. По умолчанию: Может быть одним из: |
sort string По умолчанию: Может быть одним из: |
since string Only show public keys accessed after the given time. |
Коды состояния HTTP-ответа для "List public keys"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "List public keys"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/keys
Response
Status: 200
[
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://HOSTNAME/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": false,
"read_only": false,
"last_used": "2020-06-11T22:31:57Z",
"user_id": 1,
"repository_id": 2
},
{
"key": "9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234",
"id": 3,
"url": "https://HOSTNAME/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": false,
"read_only": false,
"last_used": "2020-06-11T22:31:57Z",
"user_id": 1,
"repository_id": 2
}
]
Delete a public key
Параметры для "Delete a public key"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
key_ids string ОбязательноThe unique identifier of the key. |
Коды состояния HTTP-ответа для "Delete a public key"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Delete a public key"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/keys/KEY_IDS
Response
Status: 204
List personal access tokens
Lists personal access tokens for all users, including admin users.
Параметры для "List personal access tokens"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры запроса |
Имя, Тип, Описание |
per_page integer The number of results per page (max 100). По умолчанию: |
page integer Page number of the results to fetch. По умолчанию: |
Коды состояния HTTP-ответа для "List personal access tokens"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "List personal access tokens"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/tokens
Response
Status: 200
[
{
"id": 2,
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
"hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45",
"token_last_eight": "Ae178B4a",
"note": "My personal access token",
"note_url": null,
"created_at": "2019-04-24T21:49:02Z",
"updated_at": "2019-04-24T21:49:02Z",
"scopes": [
"admin:business",
"admin:gpg_key",
"admin:org",
"admin:org_hook",
"admin:pre_receive_hook",
"admin:public_key",
"admin:repo_hook",
"delete_repo",
"gist",
"notifications",
"repo",
"user",
"write:discussion"
],
"fingerprint": null
}
]
Delete a personal access token
Deletes a personal access token. Returns a 403 - Forbidden
status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.
Параметры для "Delete a personal access token"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
token_id integer ОбязательноThe unique identifier of the token. |
Коды состояния HTTP-ответа для "Delete a personal access token"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Delete a personal access token"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/tokens/TOKEN_ID
Response
Status: 204
Create a user
If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send "octo_cat"
as the login, a user named "octo-cat"
will be created.
If the login name or email address is already associated with an account, the server will return a 422
response.
Параметры для "Create a user"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры запроса |
Имя, Тип, Описание |
login string ОбязательноThe user's username. |
email string Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For more information, see "About authentication for your enterprise." |
Коды состояния HTTP-ответа для "Create a user"
Код состояния | Описание |
---|---|
201 | Created |
Примеры кода для "Create a user"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/users \
-d '{"login":"monalisa","email":"octocat@github.com"}'
Response
Status: 201
{
"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
}
Update the username for a user
Параметры для "Update the username for a user"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Параметры запроса |
Имя, Тип, Описание |
login string ОбязательноThe user's new username. |
Коды состояния HTTP-ответа для "Update the username for a user"
Код состояния | Описание |
---|---|
202 | Accepted |
Примеры кода для "Update the username for a user"
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/users/USERNAME \
-d '{"login":"thenewmonalisa"}'
Response
Status: 202
{
"message": "Job queued to rename user. It may take a few minutes to complete.",
"url": "https://HOSTNAME/user/1"
}
Delete a user
Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
You can delete any user account except your own.
Параметры для "Delete a user"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Коды состояния HTTP-ответа для "Delete a user"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Delete a user"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/users/USERNAME
Response
Status: 204
Create an impersonation OAuth token
Параметры для "Create an impersonation OAuth token"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Параметры запроса |
Имя, Тип, Описание |
scopes array of strings ОбязательноA list of scopes. |
Коды состояния HTTP-ответа для "Create an impersonation OAuth token"
Код состояния | Описание |
---|---|
200 | Response when getting an existing impersonation OAuth token |
201 | Response when creating a new impersonation OAuth token |
Примеры кода для "Create an impersonation OAuth token"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/users/USERNAME/authorizations \
-d '{"scopes":["public_repo"]}'
Response when getting an existing impersonation OAuth token
Status: 200
{
"id": 1,
"url": "https://HOSTNAME/authorizations/1",
"scopes": [
"public_repo"
],
"token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"token_last_eight": "Ae178B4a",
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
"app": {
"url": "http://my-github-app.com",
"name": "my github app",
"client_id": "abcde12345fghij67890"
},
"note": "optional note",
"note_url": "http://optional/note/url",
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"expires_at": "2011-10-06T17:26:27Z",
"fingerprint": "jklmnop12345678"
}
Delete an impersonation OAuth token
Параметры для "Delete an impersonation OAuth token"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Коды состояния HTTP-ответа для "Delete an impersonation OAuth token"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Delete an impersonation OAuth token"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/admin/users/USERNAME/authorizations
Response
Status: 204
Promote a user to be a site administrator
Note that you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see "HTTP verbs."
Параметры для "Promote a user to be a site administrator"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Коды состояния HTTP-ответа для "Promote a user to be a site administrator"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Promote a user to be a site administrator"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/users/USERNAME/site_admin
Response
Status: 204
Demote a site administrator
You can demote any user account except your own.
Параметры для "Demote a site administrator"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Коды состояния HTTP-ответа для "Demote a site administrator"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Demote a site administrator"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/users/USERNAME/site_admin
Response
Status: 204
Suspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403
response.
You can suspend any user account except your own.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see "HTTP verbs."
Параметры для "Suspend a user"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Параметры запроса |
Имя, Тип, Описание |
reason string The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a |
Коды состояния HTTP-ответа для "Suspend a user"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Suspend a user"
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/users/USERNAME/suspended \
-d '{"reason":"Suspended during leave of absence."}'
Response
Status: 204
Unsuspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403
response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
Параметры для "Unsuspend a user"
Заголовки |
---|
Имя, Тип, Описание |
accept string Setting to |
Параметры пути |
Имя, Тип, Описание |
username string ОбязательноThe handle for the GitHub user account. |
Параметры запроса |
Имя, Тип, Описание |
reason string The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a |
Коды состояния HTTP-ответа для "Unsuspend a user"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Unsuspend a user"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/users/USERNAME/suspended \
-d '{"reason":"Unsuspended after leave of absence."}'
Response
Status: 204