Skip to main content

ToolJwt

Struct ToolJwt 

Source
pub struct ToolJwt {
Show 15 fields pub client_id: String, pub iss: String, pub sub: String, pub exp: i64, pub iat: i64, pub names_and_roles_endpoint_url: Option<String>, pub platform_iss: String, pub deep_link_claim_data: Option<String>, pub email: Option<String>, pub name: Option<String>, pub deployment_id: String, pub message_type: String, pub roles: Vec<String>, pub context: Option<LtiContextClaim>, pub resource_link: Option<LtiResourceLinkClaim>,
}
Expand description

JWT structure for Tool-issued tokens

This structure represents the JWT token that the LTI Tool issues to clients after a successful LTI launch. It contains essential claims from the original LTI ID Token plus metadata needed by the client application.

The structure uses full LTI claim URIs with serde rename attributes to ensure proper serialization/deserialization while maintaining clean field names in code.

§Example

use atomic_lti_tool::tool_jwt::{ToolJwt, LtiContextClaim, LtiResourceLinkClaim};
use chrono::{Duration, Utc};

let tool_jwt = ToolJwt {
    client_id: "my-client-123".to_string(),
    iss: "https://mytool.example.com".to_string(),
    sub: "user-456".to_string(),
    exp: (Utc::now() + Duration::minutes(60)).timestamp(),
    iat: Utc::now().timestamp(),
    names_and_roles_endpoint_url: Some("https://lms.example.com/nrps".to_string()),
    platform_iss: "https://lms.example.com".to_string(),
    deep_link_claim_data: None,
    email: Some("user@example.com".to_string()),
    name: Some("Test User".to_string()),
    deployment_id: "deployment-789".to_string(),
    message_type: "LtiResourceLinkRequest".to_string(),
    roles: vec!["http://purl.imsglobal.org/vocab/lis/v2/membership#Learner".to_string()],
    context: Some(LtiContextClaim {
        id: "course-123".to_string(),
    }),
    resource_link: Some(LtiResourceLinkClaim {
        id: "link-456".to_string(),
    }),
};

Fields§

§client_id: String

Client ID from the LTI platform (identifies the tool registration)

§iss: String

Issuer - the URL of this tool

§sub: String

Subject - the user ID from the LMS

§exp: i64

Expiration time (Unix timestamp)

§iat: i64

Issued at time (Unix timestamp)

§names_and_roles_endpoint_url: Option<String>

Optional endpoint URL for Names and Roles Provisioning Service

§platform_iss: String

Issuer of the original platform (LMS URL)

§deep_link_claim_data: Option<String>

Optional data from deep linking claim

§email: Option<String>

User’s email address from the LTI platform

§name: Option<String>

User’s full name from the LTI platform

§deployment_id: String

LTI Deployment ID - identifies a specific deployment of the tool

See: https://www.imsglobal.org/spec/lti/v1p3#deployment-id-claim

§message_type: String

LTI Message Type (e.g., “LtiResourceLinkRequest”, “LtiDeepLinkingRequest”)

See: https://www.imsglobal.org/spec/lti/v1p3#message-type-claim

§roles: Vec<String>

User’s roles within the context (e.g., Learner, Instructor)

See: https://www.imsglobal.org/spec/lti/v1p3#roles-claim

§context: Option<LtiContextClaim>

Context information (e.g., course) - optional as not all launches have context

See: https://www.imsglobal.org/spec/lti/v1p3#context-claim

§resource_link: Option<LtiResourceLinkClaim>

Resource link information - identifies the specific placement of the tool

See: https://www.imsglobal.org/spec/lti/v1p3#resource-link-claim

Trait Implementations§

Source§

impl Clone for ToolJwt

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolJwt

Source§

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

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

impl<'de> Deserialize<'de> for ToolJwt

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 Serialize for ToolJwt

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more