Skip to main content

UsersApi

Struct UsersApi 

Source
pub struct UsersApi<'a> { /* private fields */ }
Expand description

Users API - handles all user-related endpoints

Implementations§

Source§

impl<'a> UsersApi<'a>

Source

pub async fn get(&self, user_ids: Vec<u64>) -> Result<Vec<User>>

Get users by their IDs

If no IDs are provided, returns the authenticated user’s information.

Requires OAuth token with user:read scope

§Example
// Get specific users
let users = client.users().get(vec![123, 456]).await?;

// Get current authenticated user
let me = client.users().get_me().await?;
Source

pub async fn get_me(&self) -> Result<User>

Get the currently authenticated user’s information

This is a convenience method that calls get() with no IDs.

Requires OAuth token with user:read scope

§Example
let me = client.users().get_me().await?;
println!("Logged in as: {}", me.name);
Source

pub async fn introspect_token(&self) -> Result<TokenIntrospection>

Introspect an OAuth token (validate it)

This validates the token passed in the Authorization header. Implements RFC 7662 OAuth 2.0 Token Introspection.

Note: This endpoint is deprecated but still functional.

Requires OAuth token (no specific scope needed)

§Example
let introspection = client.users().introspect_token().await?;

if introspection.is_active() {
    println!("Token is valid!");
    println!("Scopes: {:?}", introspection.scopes());

    if introspection.has_scope("user:read") {
        println!("Has user:read permission");
    }

    if introspection.is_expired() {
        println!("Token is expired!");
    }
} else {
    println!("Token is invalid");
}

Auto Trait Implementations§

§

impl<'a> Freeze for UsersApi<'a>

§

impl<'a> !RefUnwindSafe for UsersApi<'a>

§

impl<'a> Send for UsersApi<'a>

§

impl<'a> Sync for UsersApi<'a>

§

impl<'a> Unpin for UsersApi<'a>

§

impl<'a> !UnwindSafe for UsersApi<'a>

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> 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: 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: 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, 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<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