rustdesk / rustdesk/rustdesk-server-pro

API Token: no docs or CLI scripts for "Admin Role Permission" / "Control Role Permission"

Open
#1,010 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
317
Forks
119
PR merge metrics
No merged PRs in 30d

Description

Description

The API Token creation page (Settings → Tokens → Create) currently shows 9 permission categories:

  • Device Permission
  • User Permission
  • Device Group Permissions
  • User Group Permissions
  • Address Book Permission
  • Audit Log Permission
  • Strategy Permission
  • Admin Role Permission
  • Control Role Permission

(screenshot attached)

However, the official Web Console documentation
(https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#api-token)
only documents 6 permission categories with corresponding Python CLI scripts:

Permission Script
Device devices.py
User users.py
Group user_group.py / device_group.py
Address Book ab.py
Audit Log audits.py
Strategy strategies.py

There is no documented REST endpoint, and no equivalent CLI script
(e.g. admin_role.py / control_role.py), for the Admin Role Permission
and Control Role Permission token scopes.

Questions
  1. Is there a REST API that actually consumes these two token permissions
    (Admin Role / Control Role) for programmatic read/write today?
  2. If yes, could the console docs be updated with the endpoint path, method,
    and example payload/response?
  3. Are there plans to ship corresponding Python CLI scripts
    (similar to strategies.py, ab.py, etc.) for these two permissions?
Environment
  • RustDesk Server Pro version: 1.8.6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Web Console API Token documentation and the existing scripts devices.py, users.py, user_group.py, device_group.py, ab.py, audits.py, and strategies.py. Check whether the Admin Role and Control Role scopes have REST endpoints in the current server documentation or API implementation. Done means documenting confirmed endpoints and examples, or clearly recording that no supported API or scripts exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.