workos 1.0.0

Official Rust SDK for the WorkOS API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

// @oagen-ignore-file
//! Official Rust SDK for the [WorkOS API](https://workos.com).
//!
//! The SDK is built around a single [`Client`] that exposes one accessor per
//! API surface (SSO, user management, organizations, audit logs, FGA-style
//! authorization, feature flags, vault, …). Each accessor returns a typed
//! resource API whose methods map 1:1 to WorkOS endpoints.
//!
//! # Quick start
//!
//! ```no_run
//! use workos::{Client, organizations::ListOrganizationsParams};
//!
//! # async fn run() -> Result<(), workos::Error> {
//! let client = Client::new(std::env::var("WORKOS_API_KEY").unwrap());
//!
//! let orgs = client
//!     .organizations()
//!     .list_organizations(ListOrganizationsParams::default())
//!     .await?;
//!
//! for org in orgs.data {
//!     println!("{}: {}", org.id, org.name);
//! }
//! # Ok(()) }
//! ```
//!
//! # Custom HTTP transport
//!
//! The default [`Client`] uses `reqwest`, gated behind the `reqwest` feature.
//! For WASM, a shared connection pool, or custom retry/observability layers,
//! disable default features and supply your own [`transport::HttpTransport`]
//! via [`ClientBuilder::transport`].
//!
//! ```toml
//! [dependencies]
//! workos = { version = "1", default-features = false }
//! ```
//!
//! # Modules
//!
//! - [`client`] — [`Client`] and [`ClientBuilder`].
//! - [`resources`] — generated resource APIs, one per WorkOS service.
//! - [`models`] — request/response types.
//! - [`enums`] — generated enum types.
//! - [`error`] — [`Error`] and HTTP error variants.
//! - [`pagination`] — [`Page`], [`ListMetadata`], and the [`auto_paginate`] stream helper.
//! - [`transport`] — pluggable [`transport::HttpTransport`] trait.
//! - [`helpers`] — hand-rolled extras: AuthKit, JWKS, PKCE, sessions, vault crypto, webhook verification.

pub mod client;
pub mod enums;
pub mod error;
pub mod helpers;
pub mod models;
pub mod pagination;
pub mod resources;
pub mod resources_api;
pub mod secret;
pub mod transport;

pub use client::{Client, ClientBuilder, DEFAULT_BASE_URL, RequestOptions, RequestStrategy};
pub use enums::*;
pub use error::{ApiError, Error};
pub use helpers::*;
pub use models::*;
pub use pagination::{ListMetadata, Page, auto_paginate};
pub use resources::*;
pub use secret::SecretString;