hot.dev/slack-admin / ::slack::admin::usergroups

admin.usergroups.*: link IDP groups to default channels and workspaces. Scope: admin.usergroups:write (:read for listing).

Example

::usergroups ::slack::admin::usergroups

::usergroups/add-channels(::usergroups/AddChannelsRequest({
  usergroup_id: "S0123ABCDEF",
  channel_ids: ["C0123ABCDEF", "C0456GHIJKL"]
}))

Functions

add-channels

fn (request: AddChannelsRequest): Map
fn (request: AddChannelsRequest, opts: Map): Map

admin.usergroups.addChannels - Add up to 100 default channels to an IDP group.

Scope: admin.usergroups:write. Returns Slack's response body; ok: false comes back as an Err(SlackError).

add-teams

fn (request: AddTeamsRequest): Map
fn (request: AddTeamsRequest, opts: Map): Map

admin.usergroups.addTeams - Associate workspaces with an IDP group; auto_provision: true creates accounts for its members.

Scope: admin.teams:write. Returns Slack's response body; ok: false comes back as an Err(SlackError).

list-channels

fn (request: ListChannelsRequest): Map
fn (request: ListChannelsRequest, opts: Map): Map

admin.usergroups.listChannels - List the channels linked to an IDP group (channels).

Scope: admin.usergroups:read. Returns Slack's response body; ok: false comes back as an Err(SlackError).

remove-channels

fn (request: RemoveChannelsRequest): Map
fn (request: RemoveChannelsRequest, opts: Map): Map

admin.usergroups.removeChannels - Remove default channels from an IDP group.

Scope: admin.usergroups:write. Returns Slack's response body; ok: false comes back as an Err(SlackError).

Types

AddChannelsRequest

AddChannelsRequest type {
    usergroup_id: Str,
    channel_ids: Vec<Str>,
    team_id: Str?
}

AddTeamsRequest

AddTeamsRequest type {
    usergroup_id: Str,
    team_ids: Vec<Str>,
    auto_provision: Bool?
}

ListChannelsRequest

ListChannelsRequest type {
    usergroup_id: Str,
    team_id: Str?,
    include_num_members: Bool?
}

RemoveChannelsRequest

RemoveChannelsRequest type {
    usergroup_id: Str,
    channel_ids: Vec<Str>
}