Skip to content

Conversation

@jacobgoren-sb
Copy link

@jacobgoren-sb jacobgoren-sb commented Sep 30, 2025

Summary

This PR adds comprehensive documentation for API token permissions (scopes) required by the Workato CLI. Users often don't know which permissions to grant when creating API clients, leading to 403 Forbidden errors. This documentation provides clear guidance on permission requirements.

Changes

New Documentation: docs/PERMISSIONS.md

  • Quick Start Table: Shows standard development permissions needed for typical CLI workflows
  • Complete Permission Reference: All available scopes organized by category with:
    • Permission name and description
    • HTTP method and endpoint
    • Which CLI commands use each permission
  • Recommended Permission Sets:
    • Basic CLI Usage (Read-Only)
    • Standard Development (most common)
    • Full CLI Access
  • Common CLI Workflows: Required permissions for init, pull, push, recipes start/stop, etc.
  • Troubleshooting Guide: How to resolve 403 and 401 errors

Updated: README.md

  • Added permissions guidance in "Getting Your API Token" section
  • Lists standard development permissions needed
  • Links to detailed PERMISSIONS.md documentation
  • Added PERMISSIONS.md to "Next Steps" section

Benefits

  1. Reduces friction for new users setting up the CLI
  2. Prevents 403 errors by documenting required scopes upfront
  3. Improves onboarding with clear permission requirements
  4. Provides reference for troubleshooting permission issues
Scope Category Permissions Required
Workspace Details Get details
Projects & Folders List, Create
Recipes List, Create, Update, Start, Stop, Update connection
Connections List, Create, Update, Get picklist values
Recipe Lifecycle Management Get/Download/Export/Import package
Export Manifests Create, Show, Get folder assets

🤖 Generated with Claude Code

jacobgoren-sb and others added 3 commits September 30, 2025 10:54
Created PERMISSIONS.md with detailed documentation of all available
API token scopes and their corresponding CLI commands. Includes:

- Quick start table with standard development permissions
- Complete permission reference organized by scope category
- Mapping of each permission to CLI commands that use them
- Recommended permission sets for different use cases
- Common CLI workflows with required permissions
- Troubleshooting guide for permission errors

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Added guidance in the API token setup section about granting
necessary permissions when creating an API client. Includes:

- List of standard development permissions needed
- Link to comprehensive PERMISSIONS.md documentation
- Added PERMISSIONS.md to "Next Steps" section for easy access

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Cleaned up section headers by removing count indicators (e.g., "(5/6)")
for better readability. Headers now display just the section names.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant