Enum TokenScope 

pub enum TokenScope {
    Full,
    Write,
    ReadOnly,
    McpOnly,
}

What a personal access token may do with the rights of its user.

Variants

Full

Everything the user may do: read, write and approve (REST and MCP). Every token created before scopes existed, and the desktop app’s tokens, have it, so nothing changes for them.

Write

Read and write, but not approve: a change order cannot be reviewed (approved or rejected, which releases it), a change request cannot be decided and a revision cannot be made obsolete. For integrations that create and edit data but must not release it.

ReadOnly

Only reads: GET/HEAD requests and the read-only MCP tools.

McpOnly

Only the MCP endpoint (POST /api/v1/mcp), with all its tools.

Implementations

impl TokenScope

pub const ALL: [TokenScope; 4]

pub fn as_str(self) -> &'static str

pub fn parse(s: &str) -> Option<TokenScope>

Accepts the stored names and their spellings with a dash.

pub fn label(self) -> &'static str

pub fn allows_request(self, method: &str, path: &str) -> bool

Whether a request with this HTTP method to this path (the full path, e.g. /api/v1/items) is within the scope. A read_only token may post to the MCP endpoint; which tools it may call is checked there (TokenScope::allows_tool).

pub fn allows_tool(self, read_only: bool) -> bool

Whether an MCP tool may be called (read_only = the tool only reads).

pub fn refusal(self) -> &'static str

Why a request outside the scope was refused (403).

Trait Implementations

impl Clone for TokenScope

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TokenScope

impl Debug for TokenScope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TokenScope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TokenScope

impl Hash for TokenScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TokenScope

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TokenScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenScope