Slack.Web.Team.ExternalTeams (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Disconnect an external organization.

Returns a list of all the external teams connected and details about the connection.

Functions

disconnect(target_team, optional_params \\ %{})

Disconnect an external organization.

API reference

Rate limit: Tier 1: 1+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • target_team - The team ID of the target team. ex: T726G27TT

Errors the API can return:

  • invalid_target_team - target team is invalid
  • missing_argument - A required argument is missing.
  • restricted_action - The actor is restricted from archiving or disconnecting.

See the Common Errors guide for errors returned by every Web API method.

list(optional_params \\ %{})

Returns a list of all the external teams connected and details about the connection.

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Optional Params

  • connection_status_filter - Status of the connected team. Acceptable values: CONNECTED DISCONNECTED BLOCKED IN_REVIEW
  • cursor - Paginate through collections of data by setting parameter to the team_id attribute returned by a previous request's response_metadata. If not provided, the first page of the collection is returned. See pagination for more detail. ex: T123ABC456
  • limit - The maximum number of items to return per page
  • slack_connect_pref_filter - Filters connected orgs by Slack Connect pref override(s). Value can be: approved_orgs_only allow_sc_file_uploads profile_visibility away_team_sc_invite_permissions accept_sc_invites sc_mpdm_to_private require_sc_channel_for_sc_dm external_awareness_context_bar
  • sort_direction - Direction to sort in asc or desc
  • sort_field - Name of the parameter that we are sorting by
  • workspace_filter - Shows connected orgs which are connected on a specified encoded workspace ID

Errors the API can return:

  • invalid_workspace_filter - The specified workspace is not valid.
  • not_allowed - The user is not allowed to perform the action.
  • restricted_action - The user does not have permission to perform the action.
  • user_cannot_manage_workspace - The calling user cannot manage the workspace passed in the workspace filter.

See the Common Errors guide for errors returned by every Web API method.