Skip to main content

OrganizationContext

Struct OrganizationContext 

Source
pub struct OrganizationContext {
    pub org_id: OrgId,
    pub principal: Principal,
    pub request_id: RequestId,
    pub roles: Vec<RoleBinding>,
    pub org_path: Vec<OrgId>,
    pub attestation: Option<Attestation>,
}
Expand description

Platform context bundle — org, principal, request-id, roles, org-path, attestation.

Carries the cross-cutting request context (tenant ID, actor identity, request tracing ID, authorization roles, org-path, and optional credential) in a single, cheap-to-clone value. Avoids threading (org_id, principal) pairs separately through every function and middleware layer.

§Examples

use api_bones::{OrganizationContext, OrgId, Principal, RequestId, Role, RoleBinding, RoleScope, Attestation, AttestationKind};
use uuid::Uuid;

let org_id = OrgId::generate();
let principal = Principal::human(Uuid::new_v4());
let request_id = RequestId::new();

let ctx = OrganizationContext::new(org_id, principal, request_id)
    .with_roles(vec![RoleBinding { role: Role::from("admin"), scope: RoleScope::Self_ }])
    .with_attestation(Attestation {
        kind: AttestationKind::Jwt,
        raw: vec![1, 2, 3],
    });

assert_eq!(ctx.roles.len(), 1);
assert!(ctx.attestation.is_some());

Fields§

§org_id: OrgId

Tenant ID

§principal: Principal

Actor identity

§request_id: RequestId

Request tracing ID

§roles: Vec<RoleBinding>

Authorization roles

§org_path: Vec<OrgId>

Org path from root to the acting org (inclusive). Empty = platform scope.

§attestation: Option<Attestation>

Optional credential/attestation

Implementations§

Source§

impl OrganizationContext

Source

pub fn new(org_id: OrgId, principal: Principal, request_id: RequestId) -> Self

Construct a new context with org, principal, and request-id.

Roles default to an empty vec, org_path to empty, attestation to None.

§Examples
use api_bones::{OrganizationContext, OrgId, Principal, RequestId};
use uuid::Uuid;

let ctx = OrganizationContext::new(
    OrgId::generate(),
    Principal::human(Uuid::new_v4()),
    RequestId::new(),
);

assert!(ctx.roles.is_empty());
assert!(ctx.org_path.is_empty());
assert!(ctx.attestation.is_none());
Source

pub fn with_roles(self, roles: Vec<RoleBinding>) -> Self

Set the roles on this context (builder-style).

§Examples
use api_bones::{OrganizationContext, OrgId, Principal, RequestId, Role, RoleBinding, RoleScope};
use uuid::Uuid;

let ctx = OrganizationContext::new(
    OrgId::generate(),
    Principal::human(Uuid::new_v4()),
    RequestId::new(),
).with_roles(vec![RoleBinding { role: Role::from("editor"), scope: RoleScope::Self_ }]);

assert_eq!(ctx.roles.len(), 1);
Source

pub fn with_org_path(self, org_path: Vec<OrgId>) -> Self

Set the org path on this context (builder-style).

§Examples
use api_bones::{OrganizationContext, OrgId, Principal, RequestId};
use uuid::Uuid;

let org_id = OrgId::generate();
let ctx = OrganizationContext::new(
    org_id,
    Principal::human(Uuid::new_v4()),
    RequestId::new(),
).with_org_path(vec![org_id]);

assert!(!ctx.org_path.is_empty());
Source

pub fn with_attestation(self, attestation: Attestation) -> Self

Set the attestation on this context (builder-style).

§Examples
use api_bones::{OrganizationContext, OrgId, Principal, RequestId, Attestation, AttestationKind};
use uuid::Uuid;

let ctx = OrganizationContext::new(
    OrgId::generate(),
    Principal::human(Uuid::new_v4()),
    RequestId::new(),
).with_attestation(Attestation {
    kind: AttestationKind::ApiKey,
    raw: vec![42],
});

assert!(ctx.attestation.is_some());

Trait Implementations§

Source§

impl Clone for OrganizationContext

Source§

fn clone(&self) -> OrganizationContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OrganizationContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OrganizationContext

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OrganizationContext

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for OrganizationContext

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for OrganizationContext

Source§

impl StructuralPartialEq for OrganizationContext

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,