Enum ApiKeyScope 

pub enum ApiKeyScope {
    WorkflowsRead,
    RunsRead,
    RunsWrite,
    RunsManage,
    StatsRead,
    AccountsRead,
    AccountsManage,
    SignalsSend,
    Admin,
}

Permission scope for an API key.

Each scope grants access to a specific set of actions. A key with no scopes has no permissions.

Variants

WorkflowsRead

Read workflow definitions.

RunsRead

Read runs and their steps.

RunsWrite

Create new runs (trigger workflows).

RunsManage

Cancel, approve, reject, retry runs.

StatsRead

Read aggregated statistics.

AccountsRead

Read Provider Accounts and their usage.

AccountsManage

Create, update, delete and test Provider Accounts.

SignalsSend

Send signals that resume waiting runs.

Admin

Full access to all operations.

Implementations

impl ApiKeyScope

pub fn permits(&self, required: &ApiKeyScope) -> bool

Check whether this scope grants the required permission.

pub fn has_permission(scopes: &[ApiKeyScope], required: &ApiKeyScope) -> bool

Check whether a set of scopes grants the required permission.

pub fn all_non_admin() -> Vec<ApiKeyScope>

All available scopes (excluding admin).

pub fn member_allowed() -> &'static [ApiKeyScope]

Scopes a non-admin member is allowed to use.

Whitelist approach: only these scopes are permitted for members. Any scope not listed here is forbidden for non-admin users.

pub fn all_allowed_for_member(scopes: &[ApiKeyScope]) -> bool

Check whether all scopes in the set are allowed for a non-admin member.

Trait Implementations

impl Clone for ApiKeyScope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyScope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiKeyScope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiKeyScope

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

Formats the value using the given formatter.

impl Eq for ApiKeyScope

impl FromStr for ApiKeyScope

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ApiKeyScope, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ApiKeyScope

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 ApiKeyScope

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ApiKeyScope

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 ApiKeyScope

impl TryFrom<&str> for ApiKeyScope

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ApiKeyScope, <Self as TryFrom<&str>>::Error>

Performs the conversion.