Teile der REST-API-Dokumentation wurden kürzlich an andere Stelle verschoben. Falls du nicht findest, wonach du suchst, kannst du die Aktionen-REST-API-Seite ausprobieren.
Benutzer
Verwende die REST-API, um Benutzer in deinem Unternehmen zu sperren und zu entsperren.
Informationen zur Benutzerverwaltung
Diese Endpunkte sind nur für authentifizierte Websiteadministratoren verfügbar. Normale Benutzer erhalten eine 403
-Antwort.
List public keys
Parameter für „List public keys“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Abfrageparameter |
Name, type, BESCHREIBUNG |
per_page integer The number of results per page (max 100). Standard: |
page integer Page number of the results to fetch. Standard: |
direction string The direction to sort the results by. Standard: Kann eine der Folgenden sein: |
sort string Standard: Kann eine der Folgenden sein: |
since string Only show public keys accessed after the given time. |
HTTP-Antwortstatuscodes für „List public keys“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „List public keys“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-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
}
]
Delete a public key
Parameter für „Delete a public key“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
key_ids string ErforderlichThe unique identifier of the key. |
HTTP-Antwortstatuscodes für „Delete a public key“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Delete a public key“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/admin/keys/KEY_IDS
Response
Status: 204
List personal access tokens
Lists personal access tokens for all users, including admin users.
Parameter für „List personal access tokens“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Abfrageparameter |
Name, type, BESCHREIBUNG |
per_page integer The number of results per page (max 100). Standard: |
page integer Page number of the results to fetch. Standard: |
HTTP-Antwortstatuscodes für „List personal access tokens“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „List personal access tokens“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-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.
Parameter für „Delete a personal access token“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
token_id integer ErforderlichThe unique identifier of the token. |
HTTP-Antwortstatuscodes für „Delete a personal access token“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Delete a personal access token“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-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.
Parameter für „Delete a user“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
username string ErforderlichThe handle for the GitHub user account. |
HTTP-Antwortstatuscodes für „Delete a user“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Delete a user“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/admin/users/USERNAME
Response
Status: 204
Create an impersonation OAuth token
Parameter für „Create an impersonation OAuth token“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
username string ErforderlichThe handle for the GitHub user account. |
Textparameter |
Name, type, BESCHREIBUNG |
scopes array of strings ErforderlichA list of scopes. |
HTTP-Antwortstatuscodes für „Create an impersonation OAuth token“
Statuscode | BESCHREIBUNG |
---|---|
200 | Response when getting an existing impersonation OAuth token |
201 | Response when creating a new impersonation OAuth token |
Codebeispiele für „Create an impersonation OAuth token“
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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://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
Parameter für „Delete an impersonation OAuth token“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
username string ErforderlichThe handle for the GitHub user account. |
HTTP-Antwortstatuscodes für „Delete an impersonation OAuth token“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Delete an impersonation OAuth token“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-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."
Parameter für „Suspend a user“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
username string ErforderlichThe handle for the GitHub user account. |
Textparameter |
Name, type, BESCHREIBUNG |
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-Antwortstatuscodes für „Suspend a user“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Suspend a user“
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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.
Parameter für „Unsuspend a user“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
Pfadparameter |
Name, type, BESCHREIBUNG |
username string ErforderlichThe handle for the GitHub user account. |
Textparameter |
Name, type, BESCHREIBUNG |
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-Antwortstatuscodes für „Unsuspend a user“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Unsuspend a user“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/users/USERNAME/suspended \
-d '{"reason":"Unsuspended after leave of absence."}'
Response
Status: 204