open-vault/website/source/api/auth/github/index.html.md

layout	page_title	sidebar_current	description
api	GitHub - Auth Methods - HTTP API	docs-http-auth-github	This is the API documentation for the Vault GitHub auth method.

GitHub Auth Method (API)

This is the API documentation for the Vault GitHub auth method. For general information about the usage and operation of the GitHub method, please see the Vault GitHub method documentation.

This documentation assumes the GitHub method is enabled at the /auth/github path in Vault. Since it is possible to enable auth methods at any location, please update your API calls accordingly.

Configure Method

Configures the connection parameters for GitHub. This path honors the distinction between the create and update capabilities inside ACL policies.

Method	Path	Produces
POST	/auth/github/config	204 (empty body)

Parameters

• organization (string: <required>) - The organization users must be part of.
• base_url (string: "") - The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
• ttl (string: "") - Duration after which authentication will be expired.
• max_ttl (string: "") - Maximum duration after which authentication will be expired.

Sample Payload

{
  "organization": "acme-org"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/github/config

Read Configuration

Reads the GitHub configuration.

Method	Path	Produces
GET	/auth/github/config	200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/auth/github/config

Sample Response

{
  "request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "organization": "acme-org",
    "base_url": "",
    "ttl": "",
    "max_ttl": ""
  },
  "warnings": null
}

Map GitHub Teams

Map a list of policies to a team that exists in the configured GitHub organization.

Method	Path	Produces
POST	/auth/github/map/teams/:team_name	204 (empty body)

Parameters

• key (string) - GitHub team name in "slugified" format
• value (string) - Comma separated list of policies to assign

Sample Payload

{
  "value": "dev-policy"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/github/map/teams/dev

Read Team Mapping

Reads the GitHub team policy mapping.

Method	Path	Produces
GET	/auth/github/map/teams/:team_name	200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/auth/github/map/teams/dev

Sample Response

{
  "request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": {
    "key": "dev",
    "value": "dev-policy"
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

Map GitHub Users

Map a list of policies to a specific GitHub user exists in the configured organization.

Method	Path	Produces
POST	/auth/github/map/users/:user_name	204 (empty body)

Parameters

• key (string) - GitHub user name
• value (string) - Comma separated list of policies to assign

Sample Payload

{
  "value": "sethvargo-policy"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/github/map/users/sethvargo

The user with username sethvargo will be assigned the sethvargo-policy policy in addition to any team policies.

Read User Mapping

Reads the GitHub user policy mapping.

Method	Path	Produces
GET	/auth/github/map/users/:user_name	200 application/json

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/auth/github/map/users/sethvargo

Sample Response

{
  "request_id": "764b6f88-efba-51bd-ed62-cf1c9e80e37a",
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": {
    "key": "sethvargo",
    "value": "sethvargo-policy"
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

Login

Login using GitHub access token.

Method	Path	Produces
POST	/auth/github/login	200 application/json

Parameters

• token (string: <required>) - GitHub personal API token.

Sample Payload

{
  "token": "ABC123..."
}

Sample Request

$ curl \
    --request POST \
    http://127.0.0.1:8200/v1/auth/github/login

Sample Response

{
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": null,
  "warnings": null,
  "auth": {
    "client_token": "64d2a8f2-2a2f-5688-102b-e6088b76e344",
    "accessor": "18bb8f89-826a-56ee-c65b-1736dc5ea27d",
    "policies": ["default"],
    "metadata": {
      "username": "fred",
      "org": "acme-org"
    },
  },
  "lease_duration": 7200,
  "renewable": true
}