list

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of admin.users.list. Each setter takes the call that users.list returns and sets one argument:

import slackline/api/admin/users/list as users_list

users.list()
|> users_list.team_id("team_id")

Values

cursor

</>

pub fn cursor(
  call: slackline.Call(users.ListMethod, r),
  cursor: String,
) -> slackline.Call(users.ListMethod, r)

Set cursor to next_cursor returned by the previous call to list items in the next page.

include_admins

</>

pub fn include_admins(
  call: slackline.Call(users.ListMethod, r),
  include_admins: Bool,
) -> slackline.Call(users.ListMethod, r)

If true, only admin users will be returned (excludes owners). Returns all admins and owners when combined with include_owners. Cannot be used together with only_guests.

include_deactivated_user_workspaces

</>

pub fn include_deactivated_user_workspaces(
  call: slackline.Call(users.ListMethod, r),
  include_deactivated_user_workspaces: Bool,
) -> slackline.Call(users.ListMethod, r)

Only applies with org token and no team_id. If true, return workspaces for a user even if they may be deactivated on them. If false, return workspaces for a user only when user is active on them. Default is false.

include_owners

</>

pub fn include_owners(
  call: slackline.Call(users.ListMethod, r),
  include_owners: Bool,
) -> slackline.Call(users.ListMethod, r)

If true, only owner users will be returned. Cannot be used together with only_guests.

is_active

</>

pub fn is_active(
  call: slackline.Call(users.ListMethod, r),
  is_active: Bool,
) -> slackline.Call(users.ListMethod, r)

If true, only active users will be returned. If false, only deactivated users will be returned. Default is true.

limit

</>

pub fn limit(
  call: slackline.Call(users.ListMethod, r),
  limit: Int,
) -> slackline.Call(users.ListMethod, r)

Limit for how many users to be retrieved per page Defaults to 100.

only_guests

</>

pub fn only_guests(
  call: slackline.Call(users.ListMethod, r),
  only_guests: Bool,
) -> slackline.Call(users.ListMethod, r)

If true, returns only guests and their expiration dates that belong to the team_id.

team_id

</>

pub fn team_id(
  call: slackline.Call(users.ListMethod, r),
  team_id: String,
) -> slackline.Call(users.ListMethod, r)

The ID (T1234) of a workspace. Filters results to just the specified workspace.