Struct TokenScope 

pub struct TokenScope {
    pub resource_kind: String,
    pub resource_id: Option<String>,
    pub level: PermissionLevel,
}

One scope grant carried inside a scoped access token (and persisted on the token record). A scope authorizes level access to a resource identified by resource_kind + resource_id (where resource_id == None is a wildcard covering every resource of that kind).

This is the token-embedded analogue of StoredPermission: a permission binds a subject to a resource, whereas a TokenScope is baked into a bearer token so the holder carries its own (attenuated) authority. The resource_kind strings are the same canonical set documented on StoredPermission ("deployment", "project", "secret", "node", "environment").

Fields

resource_kind: String

The kind of resource this scope authorizes (e.g. "deployment").

resource_id: Option<String>

A specific resource id, or None for a wildcard (all resources of that kind).

level: PermissionLevel

The granted access level.

Implementations

impl TokenScope

pub fn new( resource_kind: impl Into<String>, resource_id: Option<String>, level: PermissionLevel, ) -> Self

Create a new token scope.

pub fn satisfies( &self, resource_kind: &str, resource_id: Option<&str>, level: PermissionLevel, ) -> bool

Whether this scope satisfies a request for level access to (resource_kind, resource_id). The scope matches when the kinds are equal, the scope’s resource_id is a wildcard (None) or exactly equals the requested id, and the scope’s level is >= the requested level.

Trait Implementations

impl Clone for TokenScope

fn clone(&self) -> TokenScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for TokenScope

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for TokenScope

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

Formats the value using the given formatter.

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 PartialEq for TokenScope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl ToSchema for TokenScope

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.