FastComments Rust SDK

cargo add fastcomments-sdk

The SDK requires Rust 2021 edition or later.

The FastComments Rust SDK consists of several modules:

• Client Module - Auto-generated API client for FastComments REST APIs

  • Complete type definitions for all API models
  • Both authenticated (DefaultApi) and public (PublicApi) endpoints
  • Full async/await support with tokio
  • See client/README.md for detailed API documentation

• SSO Module - Server-side Single Sign-On utilities

  • Secure token generation for user authentication
  • Support for both simple and secure SSO modes
  • HMAC-SHA256 based token signing

• Core Types - Shared type definitions and utilities

  • Comment models and metadata structures
  • User and tenant configurations
  • Helper functions for common operations

Using the Public API

use fastcomments_sdk::client::apis::configuration::Configuration;
use fastcomments_sdk::client::apis::public_api;

#[tokio::main]
async fn main() {
    // Create API configuration
    let config = Configuration::new();

    // Fetch comments for a page
    let result = public_api::get_comments_public(
        &config,
        public_api::GetCommentsPublicParams {
            tenant_id: "your-tenant-id".to_string(),
            urlid: Some("page-url-id".to_string()),
            url: None,
            count_only: None,
            skip: None,
            limit: None,
            sort_dir: None,
            page: None,
            sso_hash: None,
            simple_sso_hash: None,
            has_no_comment: None,
            has_comment: None,
            comment_id_filter: None,
            child_ids: None,
            start_date_time: None,
            starts_with: None,
        },
    )
    .await;

    match result {
        Ok(response) => {
            println!("Found {} comments", response.comments.len());
            for comment in response.comments {
                println!("Comment: {:?}", comment);
            }
        }
        Err(e) => eprintln!("Error fetching comments: {:?}", e),
    }
}

Using the Authenticated API

use fastcomments_sdk::client::apis::configuration::{ApiKey, Configuration};
use fastcomments_sdk::client::apis::default_api;

#[tokio::main]
async fn main() {
    // Create configuration with API key
    let mut config = Configuration::new();
    config.api_key = Some(ApiKey {
        prefix: None,
        key: "your-api-key".to_string(),
    });

    // Fetch comments using authenticated API
    let result = default_api::get_comments(
        &config,
        default_api::GetCommentsParams {
            tenant_id: "your-tenant-id".to_string(),
            skip: None,
            limit: None,
            sort_dir: None,
            urlid: Some("page-url-id".to_string()),
            url: None,
            is_spam: None,
            user_id: None,
            all_comments: None,
            for_moderation: None,
            parent_id: None,
            is_flagged: None,
            is_flagged_tag: None,
            is_by_verified: None,
            is_pinned: None,
            asc: None,
            include_imported: None,
            origin: None,
            tags: None,
        },
    )
    .await;

    match result {
        Ok(response) => {
            println!("Total comments: {}", response.count);
            for comment in response.comments {
                println!("Comment ID: {}, Text: {}", comment.id, comment.comment);
            }
        }
        Err(e) => eprintln!("Error: {:?}", e),
    }
}

Using SSO for Authentication

use fastcomments_sdk::sso::{
    fastcomments_sso::FastCommentsSSO,
    secure_sso_user_data::SecureSSOUserData,
};

fn main() {
    let api_key = "your-api-key".to_string();

    // Create secure SSO user data (server-side only!)
    let user_data = SecureSSOUserData::new(
        "user-123".to_string(),           // User ID
        "user@example.com".to_string(),   // Email
        "John Doe".to_string(),            // Username
        "https://example.com/avatar.jpg".to_string(), // Avatar URL
    );

    // Generate SSO token
    let sso = FastCommentsSSO::new_secure(api_key, &user_data).unwrap();
    let token = sso.create_token().unwrap();

    println!("SSO Token: {}", token);
    // Pass this token to your frontend for authentication
}

401 Unauthorized Errors

If you're getting 401 errors when using the authenticated API:

1. Check your API key: Ensure you're using the correct API key from your FastComments dashboard
2. Verify the tenant ID: Make sure the tenant ID matches your account
3. API key format: The API key should be passed in the Configuration:

let mut config = Configuration::new();
config.api_key = Some(ApiKey {
    prefix: None,
    key: "YOUR_API_KEY".to_string(),
});

SSO Token Issues

If SSO tokens aren't working:

1. Use secure mode for production: Always use FastCommentsSSO::new_secure() with your API key for production
2. Server-side only: Generate SSO tokens on your server, never expose your API key to clients
3. Check user data: Ensure all required fields (id, email, username) are provided

Async Runtime Errors

The SDK uses tokio for async operations. Make sure to:

1. Add tokio to your dependencies:

   [dependencies]
   tokio = { version = "1", features = ["full"] }

2. Use the tokio runtime:

   #[tokio::main]
   async fn main() {
    // Your async code here
   }

Broadcast IDs

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

For issues, questions, or feature requests:

• GitHub Issues: https://github.com/fastcomments/fastcomments-rust
• Documentation: https://docs.fastcomments.com
• Support: support@fastcomments.com

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

Response

Returns: AggregationResponse

Example

aggregate Example

Copy

1

2async fn run_aggregate() -> Result<(), Error> {

3 let params: AggregateParams = AggregateParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 aggregation_request: models::AggregationRequest {

6 predicates: vec![

7 models::QueryPredicate {

8 field: "path".to_string(),

9 operator: "EQUALS".to_string(),

10 value: models::QueryPredicateValue::String("news/article".to_string()),

11 }

12 ],

13 operations: vec![

14 models::AggregationOperation {

15 op: models::AggregationOpType::COUNT,

16 field: Some("thread_id".to_string()),

17 }

18 ],

19 sort: Some(vec![ models::AggregationRequestSort { field: "count".to_string(), descending: true } ]),

20 limit: Some(50),

21 },

22 parent_tenant_id: Some("acme-parent".to_string()),

23 include_stats: Some(true),

24 };

25 let response: AggregationResponse = aggregate(&configuration, params).await?;

26 let _ = response;

27 Ok(())

28}

29

Parameters

Response

Returns: GetAuditLogs200Response

Example

get_audit_logs Example

Copy

1

2async fn fetch_audit_logs() -> Result<GetAuditLogs200Response, Error> {

3 let cfg: &configuration::Configuration = &configuration;

4 let params: GetAuditLogsParams = GetAuditLogsParams {

5 tenant_id: "acme-corp-tenant".to_string(),

6 limit: Some(100.0),

7 skip: Some(0.0),

8 order: Some(models::SortDir::Desc),

9 after: Some(1690000000.0),

10 before: Some(1699999999.0),

11 };

12 let resp = get_audit_logs(cfg, params).await?;

13 Ok(resp)

14}

15

Parameters

Response

Returns: BlockFromCommentPublic200Response

Example

block_from_comment_public Example

Copy

1

2let params: BlockFromCommentPublicParams = BlockFromCommentPublicParams {

3 tenant_id: String::from("acme-corp-tenant"),

4 comment_id: String::from("news/article/12345"),

5 public_block_from_comment_params: models::PublicBlockFromCommentParams {

6 moderator_id: String::from("mod-9876"),

7 reason: String::from("Repeated spam links promoting phishing site"),

8 block_duration_minutes: Some(60),

9 notify_user: Some(true),

10 },

11 sso: Some(String::from("sso-token-opaque-abc123")),

12};

13let response: BlockFromCommentPublic200Response = block_from_comment_public(&configuration, params).await?;

14

Parameters

Response

Returns: UnBlockCommentPublic200Response

Example

un_block_comment_public Example

Copy

1

2let params: UnBlockCommentPublicParams = UnBlockCommentPublicParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 comment_id: "news/politics/2025-11-04-6789".to_string(),

5 public_block_from_comment_params: models::PublicBlockFromCommentParams {

6 moderator_id: "mod-cherie-01".to_string(),

7 reason: "reinstating after manual review - not abusive".to_string(),

8 },

9 sso: Some("sso-token-0a1b2c3d".to_string()),

10};

11

12let response: UnBlockCommentPublic200Response = un_block_comment_public(&configuration, params).await?;

13

Parameters

Response

Returns: CheckedCommentsForBlocked200Response

Example

checked_comments_for_blocked Example

Copy

1

2async fn example_checked_comments() -> Result<(), Error> {

3 let params: CheckedCommentsForBlockedParams = CheckedCommentsForBlockedParams {

4 tenant_id: "acme-news-tenant".to_string(),

5 comment_ids: "cmt-2025-001,cmt-2025-002".to_string(),

6 sso: Some("sso-session-7f3a".to_string()),

7 };

8 let response: CheckedCommentsForBlocked200Response = checked_comments_for_blocked(&configuration, params).await?;

9 Ok(())

10}

11

Parameters

Response

Returns: BlockFromCommentPublic200Response

Example

block_user_from_comment Example

Copy

1

2let params: BlockUserFromCommentParams = BlockUserFromCommentParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 id: "comments/news/article/abc123".to_string(),

5 block_from_comment_params: models::BlockFromCommentParams {

6 reason: Some("repeated spam and harassment".to_string()),

7 duration_minutes: Some(24 * 60),

8 notify_user: Some(true),

9 ..Default::default()

10 },

11 user_id: Some("user-1024".to_string()),

12 anon_user_id: None,

13};

14

15let response: BlockFromCommentPublic200Response = block_user_from_comment(&configuration, params).await?;

16

Parameters

Response

Returns: CreateCommentPublic200Response

Example

create_comment_public Example

Copy

1

2pub async fn example_create_comment_public() -> Result<CreateCommentPublic200Response, Error> {

3 let params = CreateCommentPublicParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 url_id: String::from("news/article/2025/nov/04/breaking-analysis"),

6 broadcast_id: String::from("site-default"),

7 comment_data: models::CommentData {

8 content: String::from("Great analysis — thank you for the deep dive!"),

9 author_name: Some(String::from("Jane Doe")),

10 author_email: Some(String::from("jane.doe@acme.com")),

11 ..Default::default()

12 },

13 session_id: Some(String::from("sess_9f8b7c6a")),

14 sso: Some(String::from("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")),

15 };

16 let response = create_comment_public(&configuration, params).await?;

17 Ok(response)

18}

19

Parameters

Response

Returns: DeleteComment200Response

Example

delete_comment Example

Copy

1

2async fn run_delete_comment() -> Result<DeleteComment200Response, Error> {

3 let params: DeleteCommentParams = DeleteCommentParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article/2025/11/04/comment-789".to_string(),

6 context_user_id: Some("user-42".to_string()),

7 is_live: Some(true),

8 };

9 let response: DeleteComment200Response = delete_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: DeleteCommentPublic200Response

Example

delete_comment_public Example

Copy

1

2async fn run_delete_comment() -> Result<(), Error> {

3 let params: DeleteCommentPublicParams = DeleteCommentPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "news/article-98765/comment-123".to_string(),

6 broadcast_id: "news/article-98765".to_string(),

7 edit_key: Some("edit-9f8e7d6c".to_string()),

8 sso: Some("sso.jwt.token.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9".to_string()),

9 };

10 let response: DeleteCommentPublic200Response = delete_comment_public(&configuration, params).await?;

11 Ok(())

12}

13

Parameters

Response

Returns: DeleteCommentVote200Response

Example

delete_comment_vote Example

Copy

1

2async fn example_delete_vote(configuration: &configuration::Configuration) -> Result<DeleteCommentVote200Response, Error> {

3 let params: DeleteCommentVoteParams = DeleteCommentVoteParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 comment_id: String::from("comment-98765"),

6 vote_id: String::from("vote-12345"),

7 url_id: String::from("news/article-2025-11-04"),

8 broadcast_id: String::from("broadcast-001"),

9 edit_key: Some(String::from("editkey-abc123")),

10 sso: Some(String::from("sso-token-xyz")),

11 };

12 let response: DeleteCommentVote200Response = delete_comment_vote(configuration, params).await?;

13 Ok(response)

14}

15

Parameters

Response

Returns: FlagComment200Response

Example

flag_comment Example

Copy

1

2async fn example_flag_comment() -> Result<FlagComment200Response, Error> {

3 let params: FlagCommentParams = FlagCommentParams {

4 tenant_id: "acme-news-tenant".to_string(),

5 id: "article/2025/11/04/comment-98765".to_string(),

6 user_id: Some("reader_204".to_string()),

7 anon_user_id: None,

8 };

9 let response: FlagComment200Response = flag_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: GetComment200Response

Example

get_comment Example

Copy

1

2let params: GetCommentParams = GetCommentParams {

3 tenant_id: "acme-news-tenant".to_string(),

4 id: "news/article/2025/11/04/interesting-story/comment-842".to_string(),

5 include_replies: Some(true),

6};

7let comment: GetComment200Response = get_comment(&configuration, params).await?;

8dbg!(comment);

9

Parameters

Response

Returns: GetCommentText200Response

Example

get_comment_text Example

Copy

1

2async fn run() -> Result<GetCommentText200Response, Error> {

3 let params: GetCommentTextParams = GetCommentTextParams {

4 tenant_id: "acme-corp-tenant".to_owned(),

5 comment_id: "cmt-7f3a9b2d".to_owned(),

6 edit_key: Some("edit-abc123".to_owned()),

7 sso: Some("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9".to_owned()),

8 };

9 let response: GetCommentText200Response = get_comment_text(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: GetCommentVoteUserNames200Response

Example

get_comment_vote_user_names Example

Copy

1

2async fn fetch_vote_user_names() -> Result<(), Error> {

3 let params: GetCommentVoteUserNamesParams = GetCommentVoteUserNamesParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "news/article-9876".to_string(),

6 dir: 1,

7 sso: Some("user-42-sso-token.eyJhbGci".to_string()),

8 };

9 let response: GetCommentVoteUserNames200Response =

10 get_comment_vote_user_names(&configuration, params).await?;

11 Ok(())

12}

13

Parameters

Response

Returns: GetComments200Response

Example

get_comments Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetCommentsParams = GetCommentsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 page: Some(1),

6 limit: Some(50),

7 skip: Some(0),

8 as_tree: Some(true),

9 skip_children: Some(0),

10 limit_children: Some(5),

11 max_tree_depth: Some(3),

12 url_id: Some("news/politics/2025-election".to_string()),

13 user_id: Some("user_12345".to_string()),

14 anon_user_id: Some("anon_98765".to_string()),

15 context_user_id: Some("editor_7".to_string()),

16 hash_tag: Some("breaking-news".to_string()),

17 parent_id: Some("comment_4f2d".to_string()),

18 direction: Some(models::SortDirections::Desc),

19 };

20 let response: GetComments200Response = get_comments(configuration, params).await?;

21 Ok(())

22}

23

req tenantId urlId

Parameters

Response

Returns: GetCommentsPublic200Response

Example

get_comments_public Example

Copy

1

2let params: GetCommentsPublicParams = GetCommentsPublicParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 url_id: "news/article/2025/11/04/rust-async".to_string(),

5 page: Some(1), direction: None, sso: None, skip: Some(0),

6 skip_children: Some(0), limit: Some(25), limit_children: Some(5),

7 count_children: Some(true), fetch_page_for_comment_id: None,

8 include_config: Some(true), count_all: Some(false), includei10n: Some(true),

9 locale: Some("en-US".to_string()), modules: Some("reactions,moderation".to_string()),

10 is_crawler: Some(false), include_notification_count: Some(true), as_tree: Some(true),

11 max_tree_depth: Some(3), use_full_translation_ids: Some(false), parent_id: None,

12 search_text: Some("climate policy".to_string()), hash_tags: Some(vec!["breaking".to_string(), "world".to_string()]),

13 user_id: Some("user_9876".to_string()), custom_config_str: None,

14 after_comment_id: Some("cmt_12345".to_string()), before_comment_id: None,

15};

16

17let response: GetCommentsPublic200Response = get_comments_public(&configuration, params).await?;

18

Parameters

Response

Returns: LockComment200Response

Example

lock_comment Example

Copy

1

2async fn run_lock_comment() -> Result<LockComment200Response, Error> {

3 let params: LockCommentParams = LockCommentParams {

4 tenant_id: "acme-news-tenant".to_string(),

5 comment_id: "cmt-2025-11-04-42".to_string(),

6 broadcast_id: "live-sports-nyc-2025-11-04".to_string(),

7 sso: Some("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature".to_string()),

8 };

9 let response: LockComment200Response = lock_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: PinComment200Response

Example

pin_comment Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: PinCommentParams = PinCommentParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "cmt-9f8d7a6b".to_string(),

6 broadcast_id: "news/article/2025/11/04".to_string(),

7 sso: Some("user-42|sig=abc123".to_string()),

8 };

9 let response: PinComment200Response = pin_comment(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: SaveComment200Response

Example

save_comment Example

Copy

1

2async fn example_save_comment() -> Result<(), Error> {

3 let create: models::CreateCommentParams = models::CreateCommentParams {

4 content: "I enjoyed this deep dive into Rust async.".to_string(),

5 thread_id: "news/tech/rust-async-2025".to_string(),

6 author_name: "Alex Rivera".to_string(),

7 author_email: "alex.rivera@acme.com".to_string(),

8 parent_id: None,

9 };

10

11 let params: SaveCommentParams = SaveCommentParams {

12 tenant_id: "acme-corp-tenant".to_string(),

13 create_comment_params: create,

14 is_live: Some(true),

15 do_spam_check: Some(true),

16 send_emails: Some(false),

17 populate_notifications: Some(true),

18 };

19

20 let response: SaveComment200Response = save_comment(&configuration, params).await?;

21 Ok(())

22}

23

Parameters

Response

Returns: Vec<models::SaveComment200Response>

Example

save_comments_bulk Example

Copy

1

2async fn save_comments_example() -> Result<Vec<models::SaveComment200Response>, Error> {

3 let comments: Vec<models::CreateCommentParams> = vec![

4 models::CreateCommentParams { thread_id: "news/article/2025/10/04".to_string(), content: "Great reporting — learned a lot.".to_string(), author_name: "Jane Doe".to_string(), author_email: "jane.doe@example.com".to_string() },

5 models::CreateCommentParams { thread_id: "news/article/2025/10/04".to_string(), parent_id: Some("cmt-12345".to_string()), content: "Replying to Jane — agree with this point.".to_string(), author_name: "John Smith".to_string(), author_email: "john.smith@acme.com".to_string() },

6 ];

7 let params: SaveCommentsBulkParams = SaveCommentsBulkParams {

8 tenant_id: "acme-corp-tenant".to_string(),

9 create_comment_params: comments,

10 is_live: Some(true),

11 do_spam_check: Some(true),

12 send_emails: Some(false),

13 populate_notifications: Some(true),

14 };

15 let saved: Vec<models::SaveComment200Response> = save_comments_bulk(&configuration, params).await?;

16 Ok(saved)

17}

18

Parameters

Response

Returns: SetCommentText200Response

Example

set_comment_text Example

Copy

1

2async fn update_comment_example(configuration: &configuration::Configuration) -> Result<SetCommentText200Response, Error> {

3 let params: SetCommentTextParams = SetCommentTextParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "news/article/2025/11/04/12345".to_string(),

6 broadcast_id: "web-frontend".to_string(),

7 comment_text_update_request: models::CommentTextUpdateRequest {

8 text: "Updated comment text with corrected facts and a mention @jane".to_string(),

9 mentions: vec![models::CommentUserMentionInfo { user_id: "user-432".to_string(), display_name: "jane.doe".to_string() }],

10 hashtags: vec![models::CommentUserHashTagInfo { tag: "breaking".to_string() }],

11 },

12 edit_key: Some("edit-key-abc123".to_string()),

13 sso: Some("sso-token-xyz".to_string()),

14 };

15 let response: SetCommentText200Response = set_comment_text(configuration, params).await?;

16 Ok(response)

17}

18

Parameters

Response

Returns: UnBlockCommentPublic200Response

Example

un_block_user_from_comment Example

Copy

1

2async fn run_unblock() -> Result<(), Error> {

3 let params: UnBlockUserFromCommentParams = UnBlockUserFromCommentParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article/comments/721".to_string(),

6 un_block_from_comment_params: models::UnBlockFromCommentParams {

7 reason: Some("User appeal accepted".to_string()),

8 },

9 user_id: Some("user-842".to_string()),

10 anon_user_id: None,

11 };

12 let response: UnBlockCommentPublic200Response =

13 un_block_user_from_comment(&configuration, params).await?;

14 Ok(())

15}

16

Parameters

Response

Returns: FlagComment200Response

Example

un_flag_comment Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: UnFlagCommentParams = UnFlagCommentParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "comments/2025-11-04-98765".to_string(),

6 user_id: Some("user-42".to_string()),

7 anon_user_id: None,

8 };

9 let response: FlagComment200Response = un_flag_comment(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: LockComment200Response

Example

un_lock_comment Example

Copy

1

2let params: UnLockCommentParams = UnLockCommentParams {

3 tenant_id: String::from("acme-corp-tenant"),

4 comment_id: String::from("cmt-9f8a7b6"),

5 broadcast_id: String::from("breaking/news/2025/11/04"),

6 sso: Some(String::from("sso-secure-8a7b6c")),

7};

8

9let response: LockComment200Response = un_lock_comment(&configuration, params).await?;

10

Parameters

Response

Returns: PinComment200Response

Example

un_pin_comment Example

Copy

1

2async fn example() -> Result<PinComment200Response, Error> {

3 let params: UnPinCommentParams = UnPinCommentParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "comment-9f8e7d6c".to_string(),

6 broadcast_id: "news/world/2025/nov/04/article-123".to_string(),

7 sso: Some("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature".to_string()),

8 };

9 let response: PinComment200Response = un_pin_comment(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: FlagCommentPublic200Response

Example

update_comment Example

Copy

1

2async fn run(configuration: &configuration::Configuration) -> Result<FlagCommentPublic200Response, Error> {

3 let params: UpdateCommentParams = UpdateCommentParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 id: String::from("news/article/comment-9876"),

6 body: models::PickApiCommentPeriodUpdatableCommentFields {

7 content: String::from("Updated: Thanks for the feedback — we've corrected the data in the article."),

8 },

9 context_user_id: Some(String::from("moderator-anna")),

10 do_spam_check: Some(true),

11 is_live: Some(true),

12 };

13 let response: FlagCommentPublic200Response = update_comment(configuration, params).await?;

14 Ok(response)

15}

16

Parameters

Response

Returns: VoteComment200Response

Example

vote_comment Example

Copy

1

2let params: VoteCommentParams = VoteCommentParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 comment_id: "c12345".to_string(),

5 url_id: "news/article/2025-election".to_string(),

6 broadcast_id: "broadcast-987".to_string(),

7 vote_body_params: models::VoteBodyParams { vote: 1 },

8 session_id: Some("sess_abc123".to_string()),

9 sso: Some("sso-token-xyz".to_string()),

10};

11let response: VoteComment200Response = vote_comment(&configuration, params).await?;

12

Parameters

Response

Returns: AddDomainConfig200Response

Example

add_domain_config Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: AddDomainConfigParams = AddDomainConfigParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 add_domain_config_params: models::AddDomainConfigParams {

6 domain: "news.acme.com".to_string(),

7 allowed_paths: Some(vec!["/articles".to_string(), "/blog".to_string()]),

8 enable_subdomains: Some(true),

9 site_name: Some("Acme News".to_string()),

10 },

11 };

12 let response: AddDomainConfig200Response = add_domain_config(&configuration, params).await?;

13 Ok(())

14}

15

Parameters

Response

Returns: DeleteDomainConfig200Response

Example

delete_domain_config Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params = DeleteDomainConfigParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 domain: String::from("news.example.com"),

6 purge_comments: Some(true),

7 };

8

9 let response: DeleteDomainConfig200Response = delete_domain_config(&configuration, params).await?;

10 println!("{:?}", response);

11 Ok(())

12}

13

Parameters

Response

Returns: GetDomainConfig200Response

Example

get_domain_config Example

Copy

1

2async fn example_get_domain_config() -> Result<(), Error> {

3 let params: GetDomainConfigParams = GetDomainConfigParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 domain: "news/article".to_string(),

6 include_subdomains: Some(true),

7 };

8 let domain_config: GetDomainConfig200Response = get_domain_config(&configuration, params).await?;

9 Ok(())

10}

11

Parameters

Response

Returns: GetDomainConfigs200Response

Example

get_domain_configs Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetDomainConfigsParams = GetDomainConfigsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 domain: Some("news.acme.com".to_string()),

6 environment: Some("production".to_string()),

7 include_inactive: Some(false),

8 };

9 let configs: GetDomainConfigs200Response = get_domain_configs(&configuration, params).await?;

10 let _ = configs;

11 Ok(())

12}

13

Parameters

Response

Returns: GetDomainConfig200Response

Example

patch_domain_config Example

Copy

1

2let params: PatchDomainConfigParams = PatchDomainConfigParams {

3 tenant_id: "acme-corp-tenant".into(),

4 domain_to_update: "news/article".into(),

5 patch_domain_config_params: models::PatchDomainConfigParams {

6 enable_comments: Some(true),

7 moderation: Some("pre-moderation".into()),

8 allowed_origins: Some(vec![

9 "https://news.acme.com".into(),

10 "https://blog.acme.com".into()

11 ]),

12 max_comment_length: Some(2000),

13 },

14};

15

16let updated: GetDomainConfig200Response = patch_domain_config(&configuration, params).await?;

17

Parameters

Response

Returns: GetDomainConfig200Response

Example

put_domain_config Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: PutDomainConfigParams = PutDomainConfigParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 domain_to_update: "news/article".to_string(),

6 update_domain_config_params: models::UpdateDomainConfigParams {

7 allow_subdomains: Some(true),

8 moderation_mode: Some("pre_moderation".to_string()),

9 allowed_origins: Some(vec![

10 "https://www.acme.com".to_string(),

11 "https://blog.acme.com".to_string(),

12 ]),

13 redirect_url: Some("https://www.acme.com/comments".to_string()),

14 },

15 };

16

17 let updated: GetDomainConfig200Response = put_domain_config(&configuration, params).await?;

18 Ok(())

19}

20

req tenantId urlId userIdWS

Parameters

Response

Returns: GetEventLog200Response

Example

get_event_log Example

Copy

1

2async fn example_get_event_log() -> Result<GetEventLog200Response, Error> {

3 let params: GetEventLogParams = GetEventLogParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 url_id: "news/article/2025/11/election-results".to_string(),

6 user_id_ws: "user-7b9f2c".to_string(),

7 start_time: 1_700_000_000i64,

8 end_time: 1_700_086_400i64,

9 cursor: Some("evt_cursor_2025_11_04".to_string()),

10 };

11 let response: GetEventLog200Response = get_event_log(&configuration, params).await?;

12 Ok(response)

13}

14

req tenantId urlId userIdWS

Parameters

Response

Returns: GetEventLog200Response

Example

get_global_event_log Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetGlobalEventLogParams = GetGlobalEventLogParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 url_id: "news/economy/q1-report".to_string(),

6 user_id_ws: "user-789-ws".to_string(),

7 start_time: 1704067200i64,

8 end_time: 1704153600i64,

9 limit: Some(100),

10 cursor: Some("cursor_0001".to_string()),

11 };

12 let response: GetEventLog200Response = get_global_event_log(&configuration, params).await?;

13 Ok(())

14}

15

Parameters

Response

Returns: CreateFeedPost200Response

Example

create_feed_post Example

Copy

1

2async fn example_create_feed_post() -> Result<(), Error> {

3 let params: CreateFeedPostParams = CreateFeedPostParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 create_feed_post_params: models::CreateFeedPostParams {

6 title: "Quarterly Update: Platform Improvements".to_string(),

7 body: "We've rolled out performance and reliability improvements across the platform.".to_string(),

8 author_id: Some("editor-joe".to_string()),

9 tags: Some(vec!["announcement".to_string(), "product".to_string()]),

10 links: Some(vec![models::FeedPostLink {

11 url: "https://acme.com/blog/q4-update".to_string(),

12 title: Some("Full Q4 Update".to_string())

13 }]),

14 media: Some(vec![models::FeedPostMediaItem {

15 url: "https://cdn.acme.com/images/q4-hero.jpg".to_string(),

16 mime_type: Some("image/jpeg".to_string()),

17 assets: Some(vec![models::FeedPostMediaItemAsset {

18 url: "https://cdn.acme.com/images/q4-hero-1200.jpg".to_string(),

19 width: Some(1200),

20 height: Some(800)

21 }])

22 }]),

23 },

24 broadcast_id: Some("news-feed-broadcast-2025".to_string()),

25 is_live: Some(true),

26 do_spam_check: Some(true),

27 skip_dup_check: Some(false),

28 };

29 let response: CreateFeedPost200Response = create_feed_post(&configuration, params).await?;

30 let _ = response;

31 Ok(())

32}

33

Parameters

Response

Returns: CreateFeedPostPublic200Response

Example

create_feed_post_public Example

Copy

1

2async fn example() -> Result<(), Error> {

3 let params: CreateFeedPostPublicParams = CreateFeedPostPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 create_feed_post_params: models::CreateFeedPostParams {

6 title: "Daily News Roundup".to_string(),

7 content: "Top stories from around the world, curated by our editorial team.".to_string(),

8 author_id: Some("editor-42".to_string()),

9 tags: Some(vec!["news".to_string(), "daily".to_string()]),

10 media: Some(vec![models::FeedPostMediaItem {

11 url: "https://cdn.acme.com/images/top_story.jpg".to_string(),

12 caption: Some("Front page image".to_string()),

13 assets: Some(vec![models::FeedPostMediaItemAsset {

14 url: "https://cdn.acme.com/images/top_story_small.jpg".to_string(),

15 mime_type: Some("image/jpeg".to_string()),

16 }]),

17 }]),

18 links: Some(vec![models::FeedPostLink {

19 url: "https://acme.example.com/articles/567".to_string(),

20 title: Some("Read full story".to_string()),

21 }]),

22 is_published: Some(true),

23 },

24 broadcast_id: Some("broadcast-2025-11".to_string()),

25 sso: Some("sso-token-abc123".to_string()),

26 };

27 let response: CreateFeedPostPublic200Response = create_feed_post_public(&configuration, params).await?;

28 Ok(())

29}

30

Parameters

Response

Returns: DeleteFeedPostPublic200Response

Example

delete_feed_post_public Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: DeleteFeedPostPublicParams = DeleteFeedPostPublicParams {

4 tenant_id: "acme-corp-tenant".to_owned(),

5 post_id: "news/article-2025-11-04".to_owned(),

6 broadcast_id: Some("global-feed".to_owned()),

7 sso: Some("sso-token-abc123".to_owned()),

8 };

9 let response: DeleteFeedPostPublic200Response = delete_feed_post_public(&configuration, params).await?;

10 Ok(())

11}

12

req tenantId afterId

Parameters

Response

Returns: GetFeedPosts200Response

Example

get_feed_posts Example

Copy

1

2let params: GetFeedPostsParams = GetFeedPostsParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 after_id: Some("post_987654321".to_string()),

5 limit: Some(20),

6 tags: Some(vec!["news/article".to_string(), "tech".to_string()]),

7};

8let response: GetFeedPosts200Response = get_feed_posts(&configuration, params).await?;

9

req tenantId afterId

Parameters

Response

Returns: GetFeedPostsPublic200Response

Example

get_feed_posts_public Example

Copy

1

2async fn fetch_feed() -> Result<(), Error> {

3 let params: GetFeedPostsPublicParams = GetFeedPostsPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 after_id: Some("post_12345".to_string()),

6 limit: Some(20),

7 tags: Some(vec!["news".to_string(), "technology".to_string()]),

8 sso: Some("editor-990".to_string()),

9 is_crawler: Some(false),

10 include_user_info: Some(true),

11 };

12 let response: GetFeedPostsPublic200Response = get_feed_posts_public(&configuration, params).await?;

13 Ok(())

14}

15

Parameters

Response

Returns: GetFeedPostsStats200Response

Example

get_feed_posts_stats Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetFeedPostsStatsParams = GetFeedPostsStatsParams {

4 tenant_id: String::from("acme-corp-tenant"),

5 post_ids: vec![

6 String::from("news/article-2025-10-01"),

7 String::from("blog/post-67890"),

8 ],

9 sso: Some(String::from("user-456-sso-token")),

10 };

11 let stats: GetFeedPostsStats200Response = get_feed_posts_stats(&configuration, params).await?;

12 Ok(())

13}

14

Parameters

Response

Returns: GetUserReactsPublic200Response

Example

get_user_reacts_public Example

Copy

1

2async fn fetch_user_reacts() -> Result<GetUserReactsPublic200Response, Error> {

3 let params: GetUserReactsPublicParams = GetUserReactsPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 post_ids: Some(vec![

6 "news/article-123".to_string(),

7 "news/article-124".to_string(),

8 ]),

9 sso: Some("sso:john.doe@example.com".to_string()),

10 };

11 let reacts: GetUserReactsPublic200Response = get_user_reacts_public(&configuration, params).await?;

12 Ok(reacts)

13}

14

Parameters

Response

Returns: ReactFeedPostPublic200Response

Example

react_feed_post_public Example

Copy

1

2async fn example_react() -> Result<ReactFeedPostPublic200Response, Error> {

3 let params: ReactFeedPostPublicParams = ReactFeedPostPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 post_id: "news/article-2025-10-31".to_string(),

6 react_body_params: models::ReactBodyParams {

7 reaction: "like".to_string(),

8 score: Some(1),

9 },

10 is_undo: Some(false),

11 broadcast_id: Some("broadcast-9c3f".to_string()),

12 sso: Some("sso-token-xyz".to_string()),

13 };

14 let response: ReactFeedPostPublic200Response = react_feed_post_public(&configuration, params).await?;

15 Ok(response)

16}

17

Parameters

Response

Returns: FlagCommentPublic200Response

Example

update_feed_post Example

Copy

1

2async fn example_update_feed_post() -> Result<FlagCommentPublic200Response, Error> {

3 let feed_post: models::FeedPost = models::FeedPost {

4 id: Some("post-2025-11-04-001".into()),

5 title: Some("Daily Tech Update — Nov 4, 2025".into()),

6 content: Some("Top stories in AI, security, and Rust ecosystem.".into()),

7 tags: Some(vec!["technology".into(), "rust".into(), "ai".into()]),

8 published: Some(true),

9 media: Some(vec![models::FeedPostMediaItem {

10 caption: Some("Cover photo".into()),

11 asset: Some(models::FeedPostMediaItemAsset {

12 url: Some("https://cdn.acme-corp.com/assets/cover-2025-11-04.jpg".into()),

13 mime_type: Some("image/jpeg".into()),

14 ..Default::default()

15 }),

16 ..Default::default()

17 }]),

18 links: Some(vec![models::FeedPostLink {

19 url: Some("https://acme-corp.com/articles/daily-tech-2025-11-04".into()),

20 text: Some("Read full story".into()),

21 ..Default::default()

22 }]),

23 ..Default::default()

24 };

25 let params: UpdateFeedPostParams = UpdateFeedPostParams {

26 tenant_id: "acme-corp-tenant".into(),

27 id: "news/daily-tech-2025-11-04".into(),

28 feed_post,

29 };

30 let resp: FlagCommentPublic200Response = update_feed_post(&configuration, params).await?;

31 Ok(resp)

32}

33

Parameters

Response

Returns: CreateFeedPostPublic200Response

Example

update_feed_post_public Example

Copy

1

2let params: UpdateFeedPostPublicParams = UpdateFeedPostPublicParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 post_id: "news/article-2025-11-04-updates".to_string(),

5 update_feed_post_params: models::UpdateFeedPostParams {

6 title: Some("Morning Briefing: Market Update".to_string()),

7 content: Some("Markets opened higher today following positive earnings reports and tech gains.".to_string()),

8 media: Some(vec![

9 models::FeedPostMediaItem {

10 asset: Some(models::FeedPostMediaItemAsset {

11 url: "https://cdn.acme.com/images/market.jpg".to_string(),

12 mime_type: Some("image/jpeg".to_string()),

13 }),

14 caption: Some("Opening bell at the exchange".to_string()),

15 }

16 ]),

17 links: Some(vec![

18 models::FeedPostLink {

19 url: "https://acme.com/articles/market-update-2025".to_string(),

20 title: Some("Read full report".to_string()),

21 }

22 ]),

23 ..Default::default()

24 },

25 broadcast_id: Some("broadcast-339".to_string()),

26 sso: Some("sso-token-abc123".to_string()),

27};

28let response: CreateFeedPostPublic200Response = update_feed_post_public(&configuration, params).await?;

29

Parameters

Response

Returns: FlagCommentPublic200Response

Example

flag_comment_public Example

Copy

1

2async fn run_flag() -> Result<FlagCommentPublic200Response, Error> {

3 let params: FlagCommentPublicParams = FlagCommentPublicParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 comment_id: "news/article/2025/67890".to_string(),

6 is_flagged: true,

7 sso: Some("sso-user-token-7f3b".to_string()),

8 };

9 let resp: FlagCommentPublic200Response = flag_comment_public(configuration, params).await?;

10 Ok(resp)

11}

12

Parameters

Response

Returns: AddPageApiResponse

Example

add_page Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let create_data: models::CreateApiPageData = models::CreateApiPageData {

4 path: "news/product-launch".to_string(),

5 url: Some("https://acme-corp.example/news/product-launch".to_string()),

6 title: Some("Acme Corp Launches New Quantum Widget".to_string()),

7 description: Some("Details on Acme's latest product release and specs.".to_string()),

8 allow_comments: Some(true),

9 };

10 let params: AddPageParams = AddPageParams {

11 tenant_id: "acme-corp-tenant".to_string(),

12 create_api_page_data: create_data,

13 };

14 let response: AddPageApiResponse = add_page(&configuration, params).await?;

15 Ok(())

16}

17

Parameters

Response

Returns: DeletePageApiResponse

Example

delete_page Example

Copy

1

2async fn example_delete_page() -> Result<(), Error> {

3 let params: DeletePageParams = DeletePageParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "news/article".to_string(),

6 force: Some(true),

7 };

8 let _response: DeletePageApiResponse = delete_page(&configuration, params).await?;

9 Ok(())

10}

11

Parameters

Response

Returns: GetPageByUrlidApiResponse

Example

get_page_by_urlid Example

Copy

1

2async fn example_get_page() -> Result<(), Error> {

3 let params: GetPageByUrlidParams = GetPageByUrlidParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 url_id: "news/politics/election-coverage-2025".to_string(),

6 include_comments: Some(true),

7 };

8 let page: GetPageByUrlidApiResponse = get_page_by_urlid(&configuration, params).await?;

9 Ok(())

10}

11

Parameters

Response

Returns: GetPagesApiResponse

Example

get_pages Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetPagesParams = GetPagesParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 path: Some("news/article".to_string()),

6 page: Some(1),

7 page_size: Some(50),

8 };

9 let pages: GetPagesApiResponse = get_pages(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: PatchPageApiResponse

Example

patch_page Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let update: models::UpdateApiPageData = models::UpdateApiPageData {

4 title: Some("Q3 Product Launch".to_string()),

5 path: Some("news/product-launch-q3".to_string()),

6 description: Some("Announcing our Q3 product lineup.".to_string()),

7 is_published: Some(true),

8 };

9 let params: PatchPageParams = PatchPageParams {

10 tenant_id: "acme-corp-tenant".to_string(),

11 id: "news/product-launch-q3".to_string(),

12 update_api_page_data: update,

13 };

14 let response: PatchPageApiResponse = patch_page(&configuration, params).await?;

15 Ok(())

16}

17

Parameters

Response

Returns: AggregateQuestionResults200Response

Example

aggregate_question_results Example

Copy

1

2async fn run_example(configuration: &configuration::Configuration) -> Result<AggregateQuestionResults200Response, Error> {

3 let params: AggregateQuestionResultsParams = AggregateQuestionResultsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 question_id: None,

6 question_ids: Some(vec!["product-q-123".to_string(), "product-q-456".to_string()]),

7 url_id: Some("news/article/2025-election".to_string()),

8 time_bucket: Some(models::AggregateTimeBucket::Daily),

9 start_date: Some("2025-01-01T00:00:00Z".to_string()),

10 force_recalculate: Some(true),

11 };

12 let response: AggregateQuestionResults200Response = aggregate_question_results(configuration, params).await?;

13 Ok(response)

14}

15

Parameters

Response

Returns: BulkAggregateQuestionResults200Response

Example

bulk_aggregate_question_results Example

Copy

1

2async fn example() -> Result<(), Error> {

3 let params: BulkAggregateQuestionResultsParams = BulkAggregateQuestionResultsParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 bulk_aggregate_question_results_request: models::BulkAggregateQuestionResultsRequest {

6 items: vec![

7 models::BulkAggregateQuestionItem {

8 question_id: "satisfaction".to_string(),

9 path: "news/article/2025/10/04/product-launch".to_string(),

10 }

11 ],

12 start_time: "2025-10-01T00:00:00Z".to_string(),

13 end_time: "2025-10-31T23:59:59Z".to_string(),

14 time_bucket: models::AggregateTimeBucket::Daily,

15 },

16 force_recalculate: Some(true),

17 };

18 let response: BulkAggregateQuestionResults200Response = bulk_aggregate_question_results(&configuration, params).await?;

19 Ok(())

20}

21

Parameters

Response

Returns: CombineCommentsWithQuestionResults200Response

Example

combine_comments_with_question_results Example

Copy

1

2let params: CombineCommentsWithQuestionResultsParams = CombineCommentsWithQuestionResultsParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 question_id: Some("q-2025-product-satisfaction".to_string()),

5 question_ids: Some(vec!["q-2025-product-satisfaction".to_string(), "q-2024-overall".to_string()]),

6 url_id: Some("news/tech/acme-launch".to_string()),

7 start_date: Some("2025-10-01T00:00:00Z".to_string()),

8 force_recalculate: Some(true),

9 min_value: Some(0.0),

10 max_value: Some(5.0),

11 limit: Some(250.0),

12};

13let combined: CombineCommentsWithQuestionResults200Response =

14 combine_comments_with_question_results(&configuration, params).await?;

15

Parameters

Response

Returns: AddSsoUserApiResponse

Example

add_sso_user Example

Copy

1

2let params: AddSsoUserParams = AddSsoUserParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 create_apisso_user_data: models::CreateApissoUserData {

5 external_id: "jane.doe@acme.com".to_string(),

6 email: "jane.doe@acme.com".to_string(),

7 display_name: "Jane Doe".to_string(),

8 roles: Some(vec!["author".to_string(), "editor".to_string()]),

9 avatar_url: Some("https://cdn.acme.com/avatars/jane.jpg".to_string()),

10 verified: Some(true),

11 metadata: None,

12 },

13};

14

15let response: AddSsoUserApiResponse = add_sso_user(&configuration, params).await?;

16

Parameters

Response

Returns: DeleteSsoUserApiResponse

Example

delete_sso_user Example

Copy

1

2async fn run_delete_sso_user_example() -> Result<DeleteSsoUserApiResponse, Error> {

3 let params: DeleteSsoUserParams = DeleteSsoUserParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "sso-user-8f7a2b".to_string(),

6 delete_comments: Some(true),

7 comment_delete_mode: Some("cascade".to_string()),

8 };

9 let response: DeleteSsoUserApiResponse = delete_sso_user(&configuration, params).await?;

10 Ok(response)

11}

12

Parameters

Response

Returns: GetSsoUserByEmailApiResponse

Example

get_sso_user_by_email Example

Copy

1

2async fn run() -> Result<(), Error> {

3 let params: GetSsoUserByEmailParams = GetSsoUserByEmailParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 email: "jane.doe@acme.com".to_string(),

6 };

7 let user: GetSsoUserByEmailApiResponse = get_sso_user_by_email(&configuration, params).await?;

8 Ok(())

9}

10

Parameters

Response

Returns: GetSsoUserByIdApiResponse

Example

get_sso_user_by_id Example

Copy

1

2async fn fetch_sso_user() -> Result<(), Error> {

3 let tenant_id_opt: Option<String> = Some("acme-corp-tenant".to_string());

4 let id_opt: Option<String> = Some("sso-user-42b7".to_string());

5 let params: GetSsoUserByIdParams = GetSsoUserByIdParams {

6 tenant_id: tenant_id_opt.unwrap(),

7 id: id_opt.unwrap(),

8 };

9 let response: GetSsoUserByIdApiResponse = get_sso_user_by_id(&configuration, params).await?;

10 Ok(())

11}

12

Parameters

Response

Returns: GetSsoUsers200Response

Example

get_sso_users Example

Copy

1

2async fn fetch_sso_users() -> Result<GetSsoUsers200Response, Error> {

3 let params: GetSsoUsersParams = GetSsoUsersParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 skip: Some(10),

6 };

7 let response: GetSsoUsers200Response = get_sso_users(&configuration, params).await?;

8 Ok(response)

9}

10

Parameters

Response

Returns: PatchSsoUserApiResponse

Example

patch_sso_user Example

Copy

1

2let params = PatchSsoUserParams {

3 tenant_id: "acme-corp-tenant".to_string(),

4 id: "user-1234".to_string(),

5 update_apisso_user_data: models::UpdateApissoUserData {

6 email: "jane.doe@acme.com".to_string(),

7 display_name: "Jane Doe".to_string(),

8 external_id: "sso-jane-doe-987".to_string(),

9 picture_url: Some("https://acme.com/avatars/jane.jpg".to_string()),

10 roles: vec!["editor".to_string(), "contributor".to_string()],

11 },

12 update_comments: Some(true),

13};

14

15let updated: PatchSsoUserApiResponse = patch_sso_user(&configuration, params).await?;

16

Parameters

Response

Returns: PutSsoUserApiResponse

Example

put_sso_user Example

Copy

1

2async fn update_sso_user() -> Result<(), Error> {

3 let params: PutSsoUserParams = PutSsoUserParams {

4 tenant_id: "acme-corp-tenant".to_string(),

5 id: "user-1234".to_string(),

6 update_apisso_user_data: models::UpdateApissoUserData {

7 sso_id: "sso|google-oauth2|1122334455".to_string(),

8 email: "jane.doe@acme.com".to_string(),

9 display_name: "Jane Doe".to_string(),

10 roles: vec!["author".to_string(), "editor".to_string()],

11 },

12 update_comments: Some(true),

13 };

14

15 let response: PutSsoUserApiResponse = put_sso_user(&configuration, params).await?;

16 Ok(())

17}

18