Administration (Enterprise)

• Create a new user
• Rename an existing user
• Create an impersonation OAuth token
• Delete an impersonation OAuth token
• Promote an ordinary user to a site administrator
• Demote a site administrator to an ordinary user
• Suspend a user
• Unsuspend a user
• List all public keys
• Delete a user
• Delete a public key

The User Administration API allows you to promote, demote, suspend, and unsuspend users on a GitHub Enterprise appliance. It is only available to authenticated site administrators. Normal users will receive a 403 response if they try to access it.

Prefix all the endpoints for this API with the following URL:

http(s)://hostname/api/v3

Create a new user

POST /admin/users

Parameters

Name	Type	Description
login	string	Required. The user's username.
email	string	Required. The user's email address.

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.

Example

{
  "login": "monalisa",
  "email": "octocat@github.com"
}

Response

Status: 201 Created

{
  "login": "octocat",
  "id": 1,
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  "followers_url": "https://api.github.com/users/octocat/followers",
  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
  "organizations_url": "https://api.github.com/users/octocat/orgs",
  "repos_url": "https://api.github.com/users/octocat/repos",
  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
  "received_events_url": "https://api.github.com/users/octocat/received_events",
  "type": "User",
  "site_admin": false
}

Rename an existing user

PATCH /admin/users/:username

Parameters

Name	Type	Description
login	string	Required. The user's new username.

Example

{
  "login": "thenewmonalisa"
}

Response

Status: 202 Accepted

{
  "message": "Job queued to rename user. It may take a few minutes to complete.",
  "url": "https://api.github.com/user/1"
}

Create an impersonation OAuth token

POST /admin/users/:username/authorizations

Parameters

Name	Type	Description
scopes	array	A list of scopes.

Response

Status: 201 Created

{
  "id": 1,
  "url": "https://api.github.com/authorizations/1",
  "scopes": [
    "public_repo"
  ],
  "token": "abcdefgh12345678",
  "token_last_eight": "12345678",
  "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",
  "fingerprint": "jklmnop12345678"
}

Delete an impersonation OAuth token

DELETE /admin/users/:username/authorizations

Response

Status: 204 No Content

Promote an ordinary user to a site administrator

PUT /users/:username/site_admin

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

Response

Status: 204 No Content

Demote a site administrator to an ordinary user

DELETE /users/:username/site_admin

You can demote any user account except your own.

Response

Status: 204 No Content

Suspend a user

PUT /users/:username/suspended

You can suspend any user account except your own.

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

Response

Status: 204 No Content

Unsuspend a user

DELETE /users/:username/suspended

Response

Status: 204 No Content

List all public keys

GET /admin/keys

Response

Status: 200 OK
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"

[
  {
    "id": 1,
    "key": "ssh-rsa AAA...",
    "url": "https://api.github.com/user/keys/1",
    "title": "octocat@octomac",
    "verified": true,
    "created_at": "2014-12-10T15:53:42Z",
    "read_only": true,
    "user_id": 232,
    "repository_id": null
  },
  {
    "id": "2",
    "key": "ssh-rsa AAA...",
    "url": "https://api.github.com/repos/octocat/Hello-World/keys/2",
    "title": "octocat@octomac",
    "verified": true,
    "created_at": "2014-12-10T15:53:42Z",
    "read_only": true,
    "user_id": null,
    "repository_id": 2333
  }
]

Delete a user

DELETE /admin/users/:username

You can delete any user account except your own.

Response

Status: 204 No Content

Delete a public key

DELETE /admin/keys/1

Response

Status: 204 No Content