ユーザ - GitHub AE Docs

ユーザ管理 API では、Enterprise でユーザをサスペンドおよびサスペンド解除できます。

これは認証されたサイト管理者のみが使用できます。通常のユーザがアクセスしようとすると、403 レスポンスを受け取ります。

List public keys

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
クエリパラメータ
名前, 種類, 説明
`per_page`integer The number of results per page (max 100). デフォルト: `30`
`page`integer Page number of the results to fetch. デフォルト: `1`
`direction`string The direction to sort the results by. デフォルト: `desc` Can be one of: `asc`, `desc`
`sort`string デフォルト: `created` Can be one of: `created`, `updated`, `accessed`
`since`string Only show public keys accessed after the given time.

HTTP response status codes

Status code	説明
`200`	OK

コードサンプル

get/admin/keys

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/keys

Response

Status: 200

[
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "id": 2,
    "url": "https://api.github.com/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://api.github.com/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
  }
]

Headers
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`key_ids`string必須 The unique identifier of the key.

List personal access tokens

Lists personal access tokens for all users, including admin users.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
クエリパラメータ
名前, 種類, 説明
`per_page`integer The number of results per page (max 100). デフォルト: `30`
`page`integer Page number of the results to fetch. デフォルト: `1`

HTTP response status codes

Status code	説明
`200`	OK

コードサンプル

get/admin/tokens

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/tokens

Response

Status: 200

[
  {
    "id": 1,
    "url": "https://api.github.com/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-09-08T17:26:27Z",
    "fingerprint": "jklmnop12345678"
  }
]

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.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`token_id`integer必須 The unique identifier of the token.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

delete/admin/tokens/{token_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/tokens/TOKEN_ID

Response

Status: 204

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.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`username`string必須 The handle for the GitHub user account.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

delete/admin/users/{username}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/users/USERNAME

Response

Status: 204

Create an impersonation OAuth token

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`username`string必須 The handle for the GitHub user account.
Body parameters
名前, 種類, 説明
`scopes`array of strings A list of scopes.

HTTP response status codes

Status code	説明
`200`	Response when getting an existing impersonation OAuth token
`201`	Response when creating a new impersonation OAuth token

コードサンプル

post/admin/users/{username}/authorizations

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/users/USERNAME/authorizations

Response when getting an existing impersonation OAuth token

Status: 200

{
  "id": 1,
  "url": "https://api.github.com/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": ""
}

Delete an impersonation OAuth token

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`username`string必須 The handle for the GitHub user account.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

delete/admin/users/{username}/authorizations

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/admin/users/USERNAME/authorizations

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

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`username`string必須 The handle for the GitHub user account.
Body parameters
名前, 種類, 説明
`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.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

put/users/{username}/suspended

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/users/USERNAME/suspended

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.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`username`string必須 The handle for the GitHub user account.
Body parameters
名前, 種類, 説明
`reason`string The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a `reason`, it will default to "Unsuspended via API by SITE_ADMINISTRATOR", where SITE_ADMINISTRATOR is the person who performed the action.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

delete/users/{username}/suspended

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/users/USERNAME/suspended

Response

Status: 204