From e80e2a800dcec2aea58565cef0a78792805aa6d7 Mon Sep 17 00:00:00 2001 From: Nils Rocine Date: Thu, 14 May 2015 13:20:58 -0700 Subject: [PATCH] Added details in the github auth docs for the website. These details clarify end-to-end use of the github auth backend. Specifically: noting how to create a usable GitHub PAT and an example of how to auth with the PAT. --- website/source/docs/auth/github.html.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/website/source/docs/auth/github.html.md b/website/source/docs/auth/github.html.md index 37d63491d4..1fa88cc71c 100644 --- a/website/source/docs/auth/github.html.md +++ b/website/source/docs/auth/github.html.md @@ -51,6 +51,10 @@ configure it, use the `/config` endpoint with the following arguments: * `organization` (string, required) - The organization name a user must be a part of to authenticate. +###Generate a GitHub Personal Access Token +Access your Personal Access Tokens in GitHub at [https://github.com/settings/tokens](https://github.com/settings/tokens). +Generate a new Token that has the scope `read:org`. Save the generated token. This is what you will provide to vault. + For example: ``` @@ -68,4 +72,15 @@ Success! Data written to: auth/github/map/teams/owners ``` The above would make anyone in the "owners" team a root user in Vault -(not recommended). +(not recommended). Note: the team ("owners") is case-sensitive. + +You can then auth with a user that is a member of the "owners" team using a Personal Access Token with the `read:org` scope. + +``` +$ vault auth -method=github token=000000905b381e723b3d6a7d52f148a5d43c4b45 +Successfully authenticated! The policies that are associated +with this token are listed below: + +root +``` +