Skip to content

docs: add docs for admin endpoint auth #5842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2020

Conversation

abhimanyusinghgaur
Copy link
Contributor

@abhimanyusinghgaur abhimanyusinghgaur commented Jul 6, 2020

Fixes #GRAPHQL-523.

This PR adds documentation about the required authentications to access the admin endpoints.
Please see this discuss post for more details: https://discuss.dgraph.io/t/authentication-for-admin-endpoints/6786


This change is Reviewable

Docs Preview: Dgraph Preview

@github-actions github-actions bot added the area/documentation Documentation related issues. label Jul 6, 2020
Copy link
Contributor

@vardhanapoorv vardhanapoorv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the formatting https://dgraph-5a7ab2e30b-75476.surge.sh/deploy/#dgraph-administration, otherwise minor comments.

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @abhimanyusinghgaur, @danielmai, and @MichaelJCompton)


wiki/content/deploy/index.md, line 2421 at r1 (raw file):

  1. IP White-listing, if `--whitelist` flag is passed to alpha.
  2. Poor-man's auth, if `--auth_token` flag is passed to alpha (means you will need to pass the `auth_token` as `X-Dgraph-AuthToken` header while making the HTTP request if this is enabled).
  3. Guardian only access, if ACL is enabled (means you need to pass the ACL JWT of a Guardian user as `X-Dgraph-AccessToken` header while making the HTTP request if this is enabled).

the ACL, JWT
can drop "if this is enabled" since already specified


wiki/content/deploy/index.md, line 2423 at r1 (raw file):

  3. Guardian only access, if ACL is enabled (means you need to pass the ACL JWT of a Guardian user as `X-Dgraph-AccessToken` header while making the HTTP request if this is enabled).

Admin endpoint means any http endpoint which provides admin functionalities. Normally, the path starts with `/admin` for such endpoints, except a few. So, at present this list includes:

So, currently ...


wiki/content/deploy/index.md, line 2435 at r1 (raw file):

There are a few exceptions to the general rule described above:
1. `/login`: This endpoint logs-in an ACL user, and provides them with JWT. Only IP Whitelisting and Poor-man's auth checks are performed for this. As one won't be able to login using ACL if we mandate Guardian only access on this.

a JWT

Copy link
Contributor

@pawanrawal pawanrawal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 2 files at r1, 1 of 1 files at r2.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @abhimanyusinghgaur, @danielmai, and @MichaelJCompton)


wiki/content/deploy/index.md, line 2421 at r2 (raw file):

1. IP White-listing, if `--whitelist` flag is passed to alpha.
2. Poor-man's auth, if `--auth_token` flag is passed to alpha (means you will need to pass the `auth_token` as `X-Dgraph-AuthToken` header while making the HTTP request).

if alpha is started with the --auth_token flag


wiki/content/deploy/index.md, line 2438 at r2 (raw file):

There are a few exceptions to the general rule described above:

1. `/login`: This endpoint logs-in an ACL user, and provides them with a JWT. Only IP Whitelisting and Poor-man's auth checks are performed for this. As one won't be able to login using ACL if we mandate Guardian only access on this.

You can remove the last line, As one won't be able to...

@abhimanyusinghgaur abhimanyusinghgaur merged commit a7dece8 into master Jul 9, 2020
@abhimanyusinghgaur abhimanyusinghgaur deleted the abhimanyu/admin-docs branch July 9, 2020 09:58
abhimanyusinghgaur added a commit that referenced this pull request Jul 9, 2020
Fixes #GRAPHQL-523.

This PR adds documentation about the required authentications to access the admin endpoints.
Please see this discuss post for more details: https://discuss.dgraph.io/t/authentication-for-admin-endpoints/6786

(cherry picked from commit a7dece8)
abhimanyusinghgaur added a commit that referenced this pull request Jul 9, 2020
Fixes #GRAPHQL-523.

This PR adds documentation about the required authentications to access the admin endpoints.
Please see this discuss post for more details: https://discuss.dgraph.io/t/authentication-for-admin-endpoints/6786

(cherry picked from commit a7dece8)
arijitAD pushed a commit that referenced this pull request Jul 14, 2020
Fixes #GRAPHQL-523.

This PR adds documentation about the required authentications to access the admin endpoints.
Please see this discuss post for more details: https://discuss.dgraph.io/t/authentication-for-admin-endpoints/6786
dna2github pushed a commit to dna2fork/dgraph that referenced this pull request Jul 18, 2020
Fixes #GRAPHQL-523.

This PR adds documentation about the required authentications to access the admin endpoints.
Please see this discuss post for more details: https://discuss.dgraph.io/t/authentication-for-admin-endpoints/6786
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related issues.
Development

Successfully merging this pull request may close these issues.

3 participants