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.

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

Spaces + rate limits #11

Merged
merged 7 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
55 changes: 53 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,64 @@ baton resources
# Data Model

`baton-confluence` will pull down information about the following Confluence resources:
- Spaces & Space Permissions
- Groups
- Users

## Space Permissions
Every Confluence space has its own set of permissions which determine what
people can do in the space.

These permissions are Entitlements for Spaces and are represented as a pair of
"operation" and "target".

Valid targets include:
- `application`
- `attachment`
- `blogpost`
- `comment`
- `database`
- `embed`
- `page`
- `space`
- `userProfile`
- `whiteboard`

Valid operations include:
- `administer`
- `archive`
- `copy`
- `create`
- `create_space`
- `delete`
- `export`
- `move`
- `purge`
- `purge_version`
- `read`
- `restore`
- `restrict_content`
- `update`

Not all operation-target pairs are valid, but here are some examples of valid ones:
- `administer-space`
- `create-attachment`
- `create-blogpost`
- `create-comment`
- `create-page`
- `delete-space`
- `export-space`
- `read-space`
- `update-space`

See [Space Permissions Overview documentation page](https://confluence.atlassian.com/doc/space-permissions-overview-139521.html).

# Contributing, Support and Issues

We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a Github Issue!
We started Baton because we were tired of taking screenshots and manually
building spreadsheets. We welcome contributions, and ideas, no matter how small
-- our goal is to make identity and permissions sprawl less painful for
everyone. If you have questions, problems, or ideas: Please open a GitHub Issue!

See [CONTRIBUTING.md](https://github.com/ConductorOne/baton/blob/main/CONTRIBUTING.md) for more details.

Expand Down Expand Up @@ -73,5 +125,4 @@ Flags:
-v, --version version for baton-confluence

Use "baton-confluence [command] --help" for more information about a command.

```
Loading
Loading