Slack.Web.Admin.Workflows.Triggers.Types.Permissions (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

List the permissions for using each trigger type.

Set the permissions for using a trigger type

Functions

lookup(trigger_type_ids, optional_params \\ %{})

List the permissions for using each trigger type.

API reference

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

View on docs.slack.dev ↗

Required Params

  • trigger_type_ids - The trigger type IDs for which to get the permissions. ex: ['FTT01', 'FTT02', 'FTT03']

Errors the API can return:

  • restricted_action - This actor does not have access to view the permissions on this resource
  • trigger_type_id_not_found - The given trigger type ID(s) do not map to valid trigger types

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

set(id, optional_params \\ %{})

Set the permissions for using a trigger type

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • id - The trigger type ID for which to set the permissions ex: ['FTT01', 'FTT02', 'FTT03']

Optional Params

  • permissions -
  • user_ids - List of user IDs to allow for named_entities visibility ex: ['U00000001', 'U00000002', 'U00000003']
  • visibility - The function visibility Acceptable values: everyone named_entities no_one

Errors the API can return:

  • invalid_named_entities - Named entities visibility requires a valid set of named entities to be specified
  • invalid_permission_set - This permission set is invalid.
  • invalid_permission_type - This permission type is invalid.
  • required_visibility - Visibility is required on this resource.
  • restricted_action - This actor does not have access to the permissions on this resource.
  • trigger_type_id_not_found - The referenced trigger type ID does not exist.
  • visibility_is_not_named_entities - The visibility should be named entities when the user_ids, team_ids, or org_ids args are set

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