• TOC {:toc}

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

PUT /users/:username/site_admin

<%= fetch_content(:put_content_length) %>

<%= headers 204 %>

DELETE /users/:username/site_admin

You can demote any user account except your own.

<%= headers 204 %>

{{#warning}}

If your GitHub Enterprise appliance has LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Users managed by an external account cannot be suspended via the API.

{{/warning}}

PUT /users/:username/suspended

You can suspend any user account except your own.

<%= fetch_content(:put_content_length) %>

<%= headers 204 %>

{{#warning}}

If your GitHub Enterprise appliance has LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Users managed by an external account cannot be unsuspended via the API.

{{/warning}}

DELETE /users/:username/suspended

<%= headers 204 %>