TELCOMA Global / Permissions & Access Review for Confluence / Documentation
Who can view and edit each space and page, and why.
Permissions & Access Review for Confluence takes a snapshot of every space's permissions, every group that grants access, and every restricted page and blog post it can find. It explains one page or one person, turns each snapshot into an access review, and changes page restrictions in bulk. Nothing changes until you confirm it, and every change can be undone from the log.
Install
Three steps, all inside Confluence.
Find the app
In Confluence go to Settings → Find new apps and search for Permissions & Access Review for Confluence.
Start the free trial
The app is paid per user, billed through Atlassian. It starts with a free trial. While the trial runs, the app shows how many days are left.
Approve the permissions
Read permissions, plus one write permission: adding or removing a person or group on a page's view or edit restriction. The app uses it only after you confirm a change.
Confluence administrators open the app under Confluence administration → Permissions & Access Review. Anyone else who opens it sees Confluence admins only. The app checks this on every request.
Take a snapshot
One button on the Overview tab. It runs in the background.
Click Take a snapshot (Take a new snapshot after the first). The app lists every space and reads its permissions, lists every group, looks through every page and blog post for view and edit restrictions, then reads the members of each group named by a space permission or a restriction. A progress line shows the step it is on. You can leave the page; the snapshot carries on.
The Spaces, Restricted pages, Person and Reviews tabs use the latest snapshot. The Page tab reads Confluence live.
When it is done, Latest snapshot shows the totals:
- Spaces, and spaces open to anonymous or other access
- Groups that grant access
- People who can reach a space or restricted page, and people who are admin of at least one space
- Pages and blog posts with a view restriction, and with an edit restriction
- Restricted pages only the admin sweep found (after a sweep, below)
Warnings appear under the totals, for example a space the app was not allowed to read (such as a personal space), or a site too large to check in full.
Cancel asks first. What the snapshot has read so far is deleted, and the latest saved snapshot stays as it is. If a snapshot makes no progress for 20 minutes, the page says it has stopped moving and offers Start again.
Add the pages you can see
Restricted pages only admins can see.
The snapshot looks for restricted pages as the app. Confluence hides from the app every page whose view restriction leaves the app out, and on many sites that is most view-restricted pages. So after each snapshot, the Overview tab offers Add the pages I can see.
- The app runs the same search as you, from your open page, and adds what it finds to the latest snapshot. Pages hidden from you as well stay missing.
- Keep the page open while it searches. If you close it, open the app again and it carries on where it stopped. The last step, Adding the pages to the review, runs in the background, and you can close the page.
- Another admin sees the sweep's progress and can Stop it, but only the admin who started it can run the search. If it has not moved for 20 minutes, the page tells them its admin may have closed the app.
- Stop asks first. The pages found so far are not added, and the sweep can be started again from the start.
- The latest review must be open. If it is signed off, reopen it to add the pages you can see. A review signed off while a sweep runs does not get the pages; the review and the evidence file say the sweep had not finished.
Every list of restricted pages says what it covers: whether an admin has swept, who, and when. Each restricted page shows who found it: App, Admin sweep only, or App and admin sweep.
Spaces
Who holds which permission on each space.
- Type a key or name in Find a space and click Search, or page through the list. Each row shows the space, its key and type.
- Show permissions lists every person and group with a permission on the space: View, Edit (the space lets them add and edit pages), Admin, and any Other permissions they hold.
- Grants that are not to a person or a group show as Anonymous (not logged in), Role: … or Other: …. The app cannot tell which people those cover.
Restricted pages
Every restricted page and blog post the app or you can see.
- Columns: Page, Space, Who can view, Who can edit, Pages below, Also limited by and Found by.
- A view restriction also applies to every page below it. A page below a restricted page shows that parent under Also limited by. Edit restrictions apply to one page only.
- Show: all restricted pages, those with a view restriction, or those with an edit restriction.
- Titles are looked up as you. A page you cannot open (one another admin found in their sweep) shows as A page you cannot open (id …). Who is listed on it is still shown, so its access can be reviewed.
Page
Who can view and edit one page, read live.
Paste a page link or a page id in Page link or id and click Look up. The app reads the page, its parent pages and its space now, as you.
- Who can view: each view restriction on the page and on its parent pages, with the groups and people listed. Only people on all of them, who can also view the space, can see the page. The space's view permission is listed below.
- Who can edit: the page's edit restriction, if it has one, the people and groups who can add and edit pages in the space (add blog posts, for a blog post), and the space admins.
- Check one person or group: choose A person or A group, search by name, pick one, and click Check. You get Can view and Can edit from Confluence's own permission check, and under Why the app's reasons. This check only reads.
- If the two disagree, the page says Confluence gives a different answer. Something the app cannot see decides it, such as product access or a space role. Go by Confluence's answer.
Confluence may not list folders among a page's parents, so a view restriction on a folder may not show here. Confluence's own answer still takes it into account.
Person
What one person can reach, and through what.
Type a name in Find a person, click Search and choose them. Their groups are read now; spaces and pages come from the latest snapshot.
- Spaces: each space they can view, with how they get View, Edit and Admin: Directly, or the group that gives it.
- Restricted pages that name them: Can view, Can edit, Named on (which restriction, directly or through which group), Blocked by and Found by.
- Not sure and Maybe, through … mean only anonymous access or a space role would let them in, and the app cannot tell whether that covers this person. Check the page on the Page tab for Confluence's own answer.
A person who can view a page can also view the pages below it, unless a page below has its own view restriction.
Reviews and sign-off
Each snapshot is a review.
The Reviews tab lists the last 12 reviews: when the snapshot was taken, how many people, the status, and how many are decided. Click Open to work on one.
- The review shows who took the snapshot, the totals (keep, remove, follow up, undecided), and how many people are new since the last signed-off review.
- Each row shows the person, their groups (and whether they are also granted access directly), how many spaces they can view, edit and admin, and how many restricted pages name them. New and New space admin mark changes since the last signed-off review.
- Set Decision to Keep, Remove or Follow up. Once a person has a decision, Note adds a note of up to 500 characters.
- Filters: Decision, Group, Space admins only and New since last review.
- Mark everyone shown as Keep asks first, and only marks people with no decision. On a large review it may say some people were not reached yet; click it again to carry on.
- Sign off this review asks first. Your name and the time are saved, decisions are locked, and the review records what its restricted page list covered at that moment.
- Reopen asks first. The earlier sign-off is kept in the review's history and in the evidence file, with the name of who reopened it.
- Delete this review is offered only for a review that has never been signed off, and deletes the snapshot and its decisions. A signed-off review is kept as evidence until it is no longer one of the last 12.
Evidence file
One workbook for your auditor.
On the Reviews tab, under Evidence file, pick a review and click Download Excel or Download CSV. The file is built in your browser.
Summary
Who took the snapshot, the status, who signed off and when (name and account ID), earlier sign-offs, the totals, the decision counts, people and space admins new since the previous review, warnings, restricted page coverage and the admin sweep, and what is not included.
People
Display name, email, account ID, groups, granted directly, spaces they can view, edit in and admin, restricted pages that name them, decision, note, decided by (name and account ID), decided at and new since previous review.
Space permissions, Groups, Restricted pages
Every grant on every space. Every group that grants access, with how many of its members can reach something. Every restricted page with its view and edit lists, pages below and who found it.
CSV and safe files
The CSV holds the People sheet. Cells a spreadsheet would read as a formula are written as plain text, so a name or note can never run anything.
Changes
Preview, confirm, then change.
Nothing changes in Confluence until you have seen the list of changes and confirmed it. Changes are made as you, so Confluence checks your own permission on each page and records you in its audit log. Only one change can be open at a time.
Copy a page's edit restriction to the pages below it. Enter the page link or id, choose Every page below it or Its direct child pages only, and click Preview the copy. Each page gets the same people and groups in its edit restriction as this page: missing ones are added, others removed. View restrictions are not changed. If this page's edit restriction leaves you out, add yourself to it first.
Add or remove a person or group on many pages. Choose Add or Remove, the View restriction or Edit restriction, and the person or group. Then choose the pages: A page and the pages below it (This page only, This page and its direct child pages or This page and every page below it), or A list of pages, one link or id per line. Click Preview the change.
- Adding to a page with no restriction of that kind creates one, so only those listed can view or edit it. You are put on a new restriction too, as Confluence does, so you can still open the page and undo the change.
- A page where the person or group is the last entry on the restriction is skipped, because removing it would open the page to everyone in the space. A page where the change would take away your own access is skipped too.
- One change covers at most 2,000 pages. Pages you cannot see are not listed and are not changed.
The preview says how many pages will change, how many already match and how many are skipped, with the reason for each. Click Apply changes and confirm, or Discard. Each page is read again just before it changes; a page that changed since the preview, so that the preview no longer holds, is left alone. Keep the page open while it runs. If you close it, open the Changes tab again to carry on. Stop stops after the page being changed.
Only the admin who planned a change can apply it. Another admin sees its progress and can stop or discard it.
Change log and undo
Every page is logged before it changes.
The log
Each change with who planned it, when, its status and how many pages changed or failed. Details shows who confirmed it and, for each page, what was done and what was not.
Undo
Undo plans a new change that reverses what worked, only where it is still needed. It has its own preview and confirm step and the same safety checks.
When a page changed since
If someone changed a page after your change, so that undoing would leave a restriction you are not on, the undo leaves that page alone and says why.
50 changes kept
When the log is full, previews that never ran go first, so a change you can still undo is not pushed out by a preview.
What it can't see
Some things Confluence doesn't show to apps.
- Restricted pages hidden from both the app and the admin who swept (or from the app alone, when no admin has swept). Each list says which.
- Archived pages, and pages in archived spaces. Confluence's search usually leaves them out, and the Page tab may report an archived page as not found.
- Who has viewed a page. Confluence does not give apps that.
- Product access and licences managed in Atlassian Administration. Someone may be in a group with space permissions but have no Confluence access. Confluence's answer on the Page tab does take that into account.
- Space roles by name, and anonymous access. The app shows the permissions Confluence reports. Where only such a grant would let someone in, it says Not sure or Maybe.
- Comments, attachments, whiteboards, databases and folders are not listed as restricted items. Pages and blog posts are. A view restriction on a folder also limits the pages in it; the app does not see that.
- Very large sites. The snapshot checks the first 200,000 pages and blog posts, and counts pages below for the first 3,000 view-restricted pages. A space with more than 10,000 permission entries is read in part, and a restriction with more than 2,000 people and groups is read in part and left alone by changes. The page says when any of these applies.
Your data
Nothing leaves Atlassian.
Spaces and their permissions, groups and the members of groups that grant access, the view and edit restrictions and parent pages of pages and blog posts, and Confluence's own permission check. Names, emails and page titles are read only to show them. It does not read page content.
Only page restrictions: adding or removing a person or group on a page's view or edit restriction, after you confirm. Never page content, space permissions or groups.
Snapshots (IDs, plus space keys and names and group names), review decisions and notes, who signed off, and the change log. People are stored as account IDs. The last 12 reviews and 50 changes are kept, in Atlassian's own storage for your site.
Nowhere. No servers of our own, no requests outside Atlassian. Evidence files are built in your browser and saved to your device.
Full details in the privacy policy.
Frequently asked
The questions admins ask first.
How is it priced?
Per user, billed through Atlassian, with a free trial. The price will be on the Atlassian Marketplace listing.
Why are some restricted pages missing?
Confluence hides a page from anyone its view restriction leaves out, the app included. Click Add the pages I can see after each snapshot. Pages hidden from you too stay missing, and the lists say so.
Can it change page content or space permissions?
No. Its only write permission adds or removes a person or group on a page's view or edit restriction, and it uses it only after you confirm.
Whose name is in Confluence's audit log?
Yours. Changes run as the admin who confirmed them, and Confluence checks that admin's permission on every page.
The app and Confluence give different answers.
Go by Confluence. Something the app cannot see decides it, such as product access in Atlassian Administration, anonymous access or a space role.
What happens when the trial ends?
The app stops working until you subscribe in Settings → Manage apps. Your saved reviews and change log are kept.
Support
Ask the people who built it.
When reporting a problem, include your site URL and what you expected to happen. We never need passwords or tokens.
Get help
One business day, usually much less.
- [email protected]
- Support page
- Known limits, what to include, status
- Response time
- Within one business day