confluence-permission

Files (2)

• SKILL.md
• API_ENDPOINTS.md · references/

SKILL.md (first lines)

# Confluence Permission Skill

Manage space and page permissions and restrictions.

---

## ⚠️ PRIMARY USE CASE

**This skill controls who can access Confluence content.** Use this skill for:
- Setting space-level permissions (who can view/edit a space)
- Adding page restrictions (limit access to specific users/groups)
- Auditing current permissions and restrictions

**⚠️⚠️ WARNING**: Permission changes can lock users out of content. Always document current permissions before making changes.

---

## When to Use This Skill

| Trigger | Example |
|---------|---------|
| View permissions | "Who can access DOCS space?", "Show page restrictions" |
| Add permissions | "Give engineering-team read access to DOCS" |
| Remove permissions | "Remove John's access to page 12345" |
| Restrict pages | "Lock this page to admins only" |
| Audit access | "List all permissions for TEAMSPACE" |

---

## When NOT to Use This Skill

| Operation | Use Instead |
|-----------|-------------|
| Create/edit pages | `confluence-page` |
| Search for content | `confluence-search` |
| Manage space settings | `confluence-space` |
| View who's watching | `confluence-watch` |

---

## Risk Levels

| Operation | Risk | Notes |
|-----------|------|-------|
| Get permissions | - | Read-only |
| Add permission | ⚠️ | Grants access, can be removed |
| Remove permission | ⚠️⚠️ | **Can lock users out** |
| Add page restriction | ⚠️⚠️ | **Can hide content from users** |
| Remove all restrictions | ⚠️ | Opens page to all space members |

---

## Overview

This skill provides comprehensive permission management for Confluence:
- **Space Permissions**: Control who can access and administer entire spaces
- **Page Restrictions**: Limit read/edit access to specific pages

Note: Due to API limitations, this skill uses a hybrid approach:
- v2 API for reading space permissions
- v1 API for modifying space permissions and managing page restrictions

## CLI Commands

### confluence-as permission space get
Retrieve the list of permissions assigned to a space.

**Usage:**
```bash
confluence-as permission space get SPACE_KEY
confluence-as permission space get DOCS --output json
```

**Output:** Lists all users and groups with their assigned operations (read, write, administer, etc.)

**Note:** Use `--output json` to see permission IDs, which are required for removing specific permissions with `confluence-as permission space remove --permission-id`.

### confluence-as permission space add
Grant a permission to a user or group for a space.

**Usage:**
```bash
confluence-as permission space add SPACE_KEY --user ACCOUNT_ID --operation read
confluence-as permission space add DOCS --group confluence-users --operation create
confluence-as permission space add TEST --user 557058:12345678-abcd-1234-efgh-123456789abc --operation administer
confluence-as permission space add DOCS --group editors --operation create --target page
```

**Options:**
- `--user` - User account ID (plain ID, no prefix)
- `--group` - Group name
- `--operation` - Permission operation (required)
- `--target` - Target type (default: `space`)

**Valid Operations:**
- `read` - View content
- `create` - Create content
- `delete` - Delete content
- `administer` - Manage space
- `archive` - Archive content
- `restrict_content` - Set content restrictions
- `export` - Export content

**Valid Targets:**
- `space` - Space-level permission (default)
- `page` - Page-level permission
- `blogpost` - Blog post permission
- `comment` - Comment permission
- `attachment` - Attachment permission

### confluence-as permission space remove
Revoke a permission from a user or group for a space.

**Usage:**
```bash
# Method 1: Remove by permission ID (preferred)
confluence-as permission space remove SPACE_KEY --permission-id 12345
confluence-as permission space remove DOCS -p 67890

From ulises-jeremias/agent-toolkit, MIT.

More from ulises-jeremias/agent-toolkit