Suspend a user

PUT

/users/{username}/suspended

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/users//suspended' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "string"
}'

响应示例

{}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

username

string

必需

Body 参数application/json

object | null

可选

reason

string

可选

The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to "Suspended via API by SITE_ADMINISTRATOR", where SITE_ADMINISTRATOR is the person who performed the action.

示例

返回响应

🟢204Response

application/json

Body

object {0}

修改于 2022-08-24 13:05:02

Unsuspend a user

Get the authenticated app