8000 Merge pull request #636 from github/update-1415716906 · QCOMXX/developer.github.com@2e67716 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2e67716

Browse files
author
hubot
committed
Merge pull request github#636 from github/update-1415716906
2 parents 8c74366 + 0e57a9b commit 2e67716

File tree

2 files changed

+13
-19
lines changed

2 files changed

+13
-19
lines changed

content/v3/enterprise.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@ GitHub Enterprise supports the same powerful API available on GitHub.com as well
1515
- Use the [Management Console][] API to perform common administrative tasks
1616
- Use the [User Administration][] API to promote, demote, suspend, and unsuspend users
1717

18-
[Admin Stats]: admin_stats/
19-
[License]: license/
20-
[Search Indexing]: search_indexing/
21-
[Management Console]: management_console/
22-
[User Administration]: /v3/users/administration/
23-
2418
## Endpoint URLs
2519

2620
All API endpoints—except [Management Console][] API endpoints—are prefixed with the following URL:
@@ -39,12 +33,17 @@ http(s)://<em>hostname</em>/
3933

4034
Your Enterprise installation's API endpoints accept [the same authentication methods](http://developer.github.com/v3/#authentication) as the GitHub.com API. Specifically, you can authenticate yourself with **[OAuth tokens][]** (which can be created using the [Authorizations API][]) or **[basic authentication][]**.
4135

42-
[OAuth tokens]: /v3/oauth/
43-
[basic authentication]: /v3/#basic-authentication
44-
45-
The [Admin Stats][], [License][], [Search Indexing][], and [User Administration][] API endpoints are only accessible to GitHub Enterprise site administrators. The [Management Console][] API endpoints are only accessible with a valid license file.
36+
The [Admin Stats][], [License][], [Search Indexing][], and [User Administration][] API endpoints are only accessible to GitHub Enterprise site administrators. The [Management Console][] API endpoints are only accessible via the [Management Console password][].
4637

4738
[Authorizations API]: /v3/oauth_authorizations/#create-a-new-authorization
39+
[OAuth tokens]: /v3/oauth/
40+
[basic authentication]: /v3/#basic-authentication
41+
[Admin Stats]: admin_stats/
42+
[License]: license/
43+
[Search Indexing]: search_indexing/
44+
[Management Console]: management_console/
45+
[User Administration]: /v3/users/administration/
46+
[Management Console password]: https://enterprise.github.com/help/articles/setting-the-management-console-password
4847

4948
## Past Releases
5049

content/v3/enterprise/management_console.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,18 @@ The Management Console API helps you manage your GitHub Enterprise installation.
1111

1212
## Authentication
1313

14-
You need to pass [an MD5 hash](https://en.wikipedia.org/wiki/MD5#MD5_hashes) of your license file as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#upload-a-license-and-software-package-for-the-first-time). On most systems, you can get this hash by simply calling `md5sum` on the license file:
14+
You need to pass your [Management Console password](https://enterprise.github.com/help/articles/setting-the-management-console-password) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#upload-a-license-and-software-package-for-the-first-time).
1515

16-
<pre class="terminal">
17-
$ md5sum github-enterprise.ghl
18-
5d10ffffa442a336061daee294536234 github-enterprise.ghl
19-
</pre>
20-
21-
You can use the `license_md5` parameter to send this token with each request. For example:
16+
Use the `api_key` parameter to send this token with each request. For example:
2217

2318
<pre class="terminal">
24-
$ curl 'http://<em>hostname</em>/setup/api?license_md5=<em>md5-checksum-of-license</em>'
19+
$ curl 'http://<em>hostname</em>/setup/api?api_key=<em>your-amazing-password</em>'
2520
</pre>
2621

2722
You can also use standard HTTP authentication to send this token. For example:
2823

2924
<pre class="terminal">
30-
$ curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api'
25+
$ curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api'
3126
</pre>
3227

3328
## Upload a license and software package for the first time

0 commit comments

Comments
 (0)
0