Skip to content

Commit 5752b25

Browse files
authored
Update index.html.markdown (#2083)
1 parent 39fed6b commit 5752b25

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

website/docs/index.html.markdown

+4-1
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,13 @@ provider "github" {
7575
### GitHub App Installation
7676

7777
To authenticate using a GitHub App installation, ensure that arguments in the `app_auth` block or the `GITHUB_APP_XXX` environment variables are set.
78+
The `owner` parameter required in this situation. Leaving out will throw a `403 "Resource not accessible by integration"` error.
7879

7980
Some API operations may not be available when using a GitHub App installation configuration. For more information, refer to the list of [supported endpoints](https://docs.github.com/en/rest/overview/endpoints-available-for-github-apps).
8081

8182
```terraform
8283
provider "github" {
84+
owner = var.github_organization
8385
app_auth {
8486
id = var.app_id # or `GITHUB_APP_ID`
8587
installation_id = var.app_installation_id # or `GITHUB_APP_INSTALLATION_ID`
@@ -92,6 +94,7 @@ provider "github" {
9294

9395
```terraform
9496
provider "github" {
97+
owner = var.github_organization
9598
app_auth {} # When using `GITHUB_APP_XXX` environment variables
9699
}
97100
```
@@ -104,7 +107,7 @@ The following arguments are supported in the `provider` block:
104107

105108
* `base_url` - (Optional) This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the `GITHUB_BASE_URL` environment variable. The value must end with a slash, for example: `https://terraformtesting-ghe.westus.cloudapp.azure.com/`
106109

107-
* `owner` - (Optional) This is the target GitHub organization or individual user account to manage. For example, `torvalds` and `github` are valid owners. It is optional to provide this value and it can also be sourced from the `GITHUB_OWNER` environment variable. When not provided and a `token` is available, the individual user account owning the `token` will be used. When not provided and no `token` is available, the provider may not function correctly.
110+
* `owner` - (Optional) This is the target GitHub organization or individual user account to manage. For example, `torvalds` and `github` are valid owners. It is optional to provide this value and it can also be sourced from the `GITHUB_OWNER` environment variable. When not provided and a `token` is available, the individual user account owning the `token` will be used. When not provided and no `token` is available, the provider may not function correctly. It is required in case of GitHub App Installation.
108111

109112
* `organization` - (Deprecated) This behaves the same as `owner`, which should be used instead. This value can also be sourced from the `GITHUB_ORGANIZATION` environment variable.
110113

0 commit comments

Comments
 (0)