Skip to content
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.

Sign up for GitHub

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

doc: add note section on the token for organization member management #528

Merged
merged 3 commits into from
Dec 1, 2024
Merged

doc: add note section on the token for organization member management #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be837a9
chore: add note section on the token for organization member management
marcaurele Nov 28, 2024
09c756b
typo
marcaurele Nov 28, 2024
027398b
fix: docs
jianyuan Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
---
# Generated from templates/index.md.tmpl
# DO NOT EDIT DIRECTLY

page_title: "Official Sentry Terraform Provider"
description: |-
Set up Sentry Team, Projects, Alerts, and more. This provider is maintained with [Sentry.io](https://sentry.io)'s sponsorship. Please add any bug reports/feature requests in the GitHub repo.
Expand Down Expand Up @@ -28,6 +31,8 @@ It's best practice not to store the authentication token in plain text. As an al
provider "sentry" {}
```

**NOTE:** Integration tokens are tied to the organization, not to a specific user. This means they cannot be used to invite or delete users, as their scopes do not include permissions at such a high level. A personal authentication token tied to your user role can perform organization member-related actions if your user role is set to Manager or Owner.

### Self-hosted Sentry

If you are self-hosting Sentry, you can set the base URL here. The URL format must be in the format `https://[hostname]/api/`.
Expand Down
5 changes: 5 additions & 0 deletions templates/index.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
---
# Generated from templates/index.md.tmpl
# DO NOT EDIT DIRECTLY

page_title: "Official Sentry Terraform Provider"
description: |-
Set up Sentry Team, Projects, Alerts, and more. This provider is maintained with [Sentry.io](https://sentry.io)'s sponsorship. Please add any bug reports/feature requests in the GitHub repo.
Expand Down Expand Up @@ -28,6 +31,8 @@ It's best practice not to store the authentication token in plain text. As an al
provider "sentry" {}
```

**NOTE:** Integration tokens are tied to the organization, not to a specific user. This means they cannot be used to invite or delete users, as their scopes do not include permissions at such a high level. A personal authentication token tied to your user role can perform organization member-related actions if your user role is set to Manager or Owner.

### Self-hosted Sentry

If you are self-hosting Sentry, you can set the base URL here. The URL format must be in the format `https://[hostname]/api/`.
Expand Down