slack_web_api v1.2.1 SlackWebAPI.Api.UsergroupsUsers

API calls for all endpoints tagged UsergroupsUsers.

Link to this section Summary

Functions

List all users in a User Group

Update the list of users for a User Group

Link to this section Functions

Link to this function

usergroups_users_list(connection, opts \\ [])

usergroups_users_list(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

List all users in a User Group

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

usergroups_users_update(connection, opts \\ [])

usergroups_users_update(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Update the list of users for a User Group

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :token (String.t): Authentication token. Requires scope: usergroups:write
    • :users (String.t): A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
    • :include_count (boolean()): Include the number of users in the User Group.
    • :usergroup (String.t): The encoded ID of the User Group to update.

Returns

{:ok, %{}} on success {:error, info} on failure