slackline/api/admin/apps
This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.
Admin apps: approve, restrict and configure apps across an Enterprise organization.
Types
Identifies admin.apps.activities.list in the slackline.Call that
activities_list returns.
pub type ActivitiesList
A successful response from admin.apps.activities.list.
pub type ActivitiesListResponse {
ActivitiesListResponse(
activities: option.Option(List(common.AppActivity)),
response_metadata: option.Option(slackline.ResponseMetadata),
)
}
Constructors
-
ActivitiesListResponse( activities: option.Option(List(common.AppActivity)), response_metadata: option.Option(slackline.ResponseMetadata), )
The kind of app component that logged an activity.
pub type ActivityComponentType {
EventsApi
Workflows
Functions
Tables
}
Constructors
-
EventsApievents_api -
Workflowsworkflows -
Functionsfunctions -
Tablestables
Who logged an app activity.
pub type ActivitySource {
Slack
Developer
}
Constructors
-
Slackslack -
Developerdeveloper
An app’s configuration, from admin.apps.config.lookup.
pub type AppConfig {
AppConfig(
app_id: String,
workflow_auth_strategy: option.Option(WorkflowAuthStrategy),
rich_link_preview_type: option.Option(RichLinkPreviewType),
domain_restrictions: option.Option(DomainRestrictions),
)
}
Constructors
-
AppConfig( app_id: String, workflow_auth_strategy: option.Option(WorkflowAuthStrategy), rich_link_preview_type: option.Option(RichLinkPreviewType), domain_restrictions: option.Option(DomainRestrictions), )Arguments
- rich_link_preview_type
-
Null when not set.
- domain_restrictions
-
Domain restrictions for the app, if set.
Who can access an app or MCP server.
pub type AppPermissionType {
Everyone
NamedEntities
NamedEntitiesExclude
NoOne
UnknownAppPermissionType(String)
}
Constructors
-
Everyoneeveryone -
NamedEntitiesnamed_entities -
NamedEntitiesExcludenamed_entities_exclude -
NoOneno_one -
UnknownAppPermissionType(String)A value that this version of slackline does not know.
An app’s access permissions.
pub type AppPermissions {
AppPermissions(
permission_type: option.Option(AppPermissionType),
user_ids: option.Option(List(String)),
usergroup_ids: option.Option(List(String)),
channel_restriction_mode: option.Option(
ChannelRestrictionMode,
),
channel_ids: option.Option(List(String)),
)
}
Constructors
-
AppPermissions( permission_type: option.Option(AppPermissionType), user_ids: option.Option(List(String)), usergroup_ids: option.Option(List(String)), channel_restriction_mode: option.Option(ChannelRestrictionMode), channel_ids: option.Option(List(String)), )Arguments
- user_ids
-
Users granted (or excluded from) access with
named_entitiespermissions. - usergroup_ids
-
Usergroups granted (or excluded from) access with
named_entitiespermissions. - channel_restriction_mode
-
no_onewhenpermission_typeisno_one. - channel_ids
-
Channels the restriction mode applies to.
Who last approved or restricted an app.
pub type AppResolver {
AppResolver(
actor_id: option.Option(String),
actor_type: option.Option(String),
)
}
Constructors
-
AppResolver( actor_id: option.Option(String), actor_type: option.Option(String), )Arguments
- actor_type
-
Such as
user.
Identifies admin.apps.approve in the slackline.Call that approve
returns.
pub type Approve
Identifies admin.apps.approved.list in the slackline.Call that
approved_list returns.
pub type ApprovedList
A successful response from admin.apps.approved.list.
pub type ApprovedListResponse {
ApprovedListResponse(
approved_apps: option.Option(List(ResolvedApp)),
response_metadata: option.Option(slackline.ResponseMetadata),
)
}
Constructors
-
ApprovedListResponse( approved_apps: option.Option(List(ResolvedApp)), response_metadata: option.Option(slackline.ResponseMetadata), )
Where an app can be used in channels.
pub type ChannelRestrictionMode {
AllChannels
SpecificChannels
AllChannelsExcept
ChannelRestrictionNoOne
UnknownChannelRestrictionMode(String)
}
Constructors
-
AllChannelsall_channels -
SpecificChannelsspecific_channels -
AllChannelsExceptall_channels_except -
ChannelRestrictionNoOneno_one -
UnknownChannelRestrictionMode(String)A value that this version of slackline does not know.
Identifies admin.apps.clearResolution in the slackline.Call that
clear_resolution returns.
pub type ClearResolution
Identifies admin.apps.config.lookup in the slackline.Call that
config_lookup returns.
pub type ConfigLookup
A successful response from admin.apps.config.lookup.
pub type ConfigLookupResponse {
ConfigLookupResponse(configs: option.Option(List(AppConfig)))
}
Constructors
-
ConfigLookupResponse(configs: option.Option(List(AppConfig)))
Identifies admin.apps.config.set in the slackline.Call that config_set
returns.
pub type ConfigSet
Allowed URLs and emails for connector authorization.
pub type DomainRestrictions {
DomainRestrictions(
urls: option.Option(List(String)),
emails: option.Option(List(String)),
)
}
Constructors
-
DomainRestrictions( urls: option.Option(List(String)), emails: option.Option(List(String)), )
Identifies admin.apps.mcp.servers.list in the slackline.Call that
mcp_servers_list returns.
pub type McpServersList
Identifies admin.apps.mcp.servers.permissions.list in the slackline.Call
that mcp_servers_permissions_list returns.
pub type McpServersPermissionsList
Identifies admin.apps.mcp.servers.permissions.set in the slackline.Call
that mcp_servers_permissions_set returns.
pub type McpServersPermissionsSet
Identifies admin.apps.permissions.add in the slackline.Call that
permissions_add returns.
pub type PermissionsAdd
Identifies admin.apps.permissions.list in the slackline.Call that
permissions_list returns.
pub type PermissionsList
Identifies admin.apps.permissions.remove in the slackline.Call that
permissions_remove returns.
pub type PermissionsRemove
Identifies admin.apps.permissions.set in the slackline.Call that
permissions_set returns.
pub type PermissionsSet
Identifies admin.apps.requests.cancel in the slackline.Call that
requests_cancel returns.
pub type RequestsCancel
Identifies admin.apps.requests.list in the slackline.Call that
requests_list returns.
pub type RequestsList
A successful response from admin.apps.requests.list.
pub type RequestsListResponse {
RequestsListResponse(
app_requests: option.Option(List(event.AppRequest)),
response_metadata: option.Option(slackline.ResponseMetadata),
)
}
Constructors
-
RequestsListResponse( app_requests: option.Option(List(event.AppRequest)), response_metadata: option.Option(slackline.ResponseMetadata), )
An approved or restricted app, from admin.apps.approved.list or
admin.apps.restricted.list.
pub type ResolvedApp {
ResolvedApp(
app: option.Option(event.AppDetails),
scopes: option.Option(List(event.AppScope)),
date_updated: option.Option(Int),
last_resolved_by: option.Option(AppResolver),
)
}
Constructors
-
ResolvedApp( app: option.Option(event.AppDetails), scopes: option.Option(List(event.AppScope)), date_updated: option.Option(Int), last_resolved_by: option.Option(AppResolver), )Arguments
- date_updated
-
When the resolution was last updated (Unix time).
Identifies admin.apps.restrict in the slackline.Call that restrict
returns.
pub type Restrict
Identifies admin.apps.restricted.list in the slackline.Call that
restricted_list returns.
pub type RestrictedList
A successful response from admin.apps.restricted.list.
pub type RestrictedListResponse {
RestrictedListResponse(
restricted_apps: option.Option(List(ResolvedApp)),
response_metadata: option.Option(slackline.ResponseMetadata),
)
}
Constructors
-
RestrictedListResponse( restricted_apps: option.Option(List(ResolvedApp)), response_metadata: option.Option(slackline.ResponseMetadata), )
The app-level override for rich link previews.
pub type RichLinkPreviewType {
AllDetails
LimitedDetails
NoPreview
DefaultToGlobalSetting
UnknownRichLinkPreviewType(String)
}
Constructors
-
AllDetailsall_details -
LimitedDetailslimited_details -
NoPreviewno_preview -
DefaultToGlobalSettingdefault_to_global_setting -
UnknownRichLinkPreviewType(String)A value that this version of slackline does not know.
Identifies admin.apps.uninstall in the slackline.Call that uninstall
returns.
pub type Uninstall
Whether a workflow builder can delegate their auth for end-user runs.
pub type WorkflowAuthStrategy {
BuilderChoice
EndUserOnly
UnknownWorkflowAuthStrategy(String)
}
Constructors
-
BuilderChoicebuilder_choice -
EndUserOnlyend_user_only -
UnknownWorkflowAuthStrategy(String)A value that this version of slackline does not know.
Values
pub fn activities_list() -> slackline.Call(
ActivitiesList,
ActivitiesListResponse,
)
admin.apps.activities.list:
Get logs for a specified team/org
apps.ActivitiesList identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/activities_list.
User token scopes: admin.app_activities:read.
Rate limit tier: t3.
Documented errors: invalid_app, invalid_app_id, invalid_args,
invalid_cursor, invalid_team.
pub fn activities_list_response_decoder() -> decode.Decoder(
ActivitiesListResponse,
)
Decodes the response from admin.apps.activities.list.
pub fn activity_component_type_decoder() -> decode.Decoder(
ActivityComponentType,
)
Decodes ActivityComponentType from a json string.
pub fn activity_component_type_from_string(
string: String,
) -> Result(ActivityComponentType, Nil)
Parses ActivityComponentType from its json string.
pub fn activity_component_type_to_json(
it: ActivityComponentType,
) -> json.Json
Encodes ActivityComponentType as a json string.
pub fn activity_component_type_to_string(
it: ActivityComponentType,
) -> String
The json string of ActivityComponentType.
pub fn activity_source_decoder() -> decode.Decoder(ActivitySource)
Decodes ActivitySource from a json string.
pub fn activity_source_from_string(
string: String,
) -> Result(ActivitySource, Nil)
Parses ActivitySource from its json string.
pub fn activity_source_to_json(it: ActivitySource) -> json.Json
Encodes ActivitySource as a json string.
pub fn activity_source_to_string(it: ActivitySource) -> String
The json string of ActivitySource.
pub fn app_config_decoder() -> decode.Decoder(AppConfig)
Decodes AppConfig from json.
pub fn app_permission_type_decoder() -> decode.Decoder(
AppPermissionType,
)
Decodes AppPermissionType from a json string.
pub fn app_permission_type_from_string(
string: String,
) -> AppPermissionType
Parses AppPermissionType from its json string.
pub fn app_permission_type_to_json(
it: AppPermissionType,
) -> json.Json
Encodes AppPermissionType as a json string.
pub fn app_permission_type_to_string(
it: AppPermissionType,
) -> String
The json string of AppPermissionType.
pub fn app_permissions_decoder() -> decode.Decoder(AppPermissions)
Decodes AppPermissions from json.
pub fn app_permissions_to_json(it: AppPermissions) -> json.Json
Encodes AppPermissions as json.
pub fn app_resolver_decoder() -> decode.Decoder(AppResolver)
Decodes AppResolver from json.
pub fn app_resolver_to_json(it: AppResolver) -> json.Json
Encodes AppResolver as json.
pub fn approve() -> slackline.Call(Approve, Nil)
admin.apps.approve:
Approve an app for installation on a workspace.
apps.Approve identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/approve.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
app_not_eligible_for_auto_install, app_restricted_org_wide,
auto_install_rule_creation_failed,
custom_integration_not_allowed_at_enterprise, feature_not_enabled,
invalid_app_id, invalid_approved_acl, invalid_request_id,
invalid_scopes, not_allowed_to_create_automation_rule, not_an_admin,
org_resolution_required, request_already_resolved,
request_id_or_app_id_is_required,
request_id_required_for_custom_integrations, team_not_found,
too_many_ids_provided, too_many_teams_provided.
pub fn approved_list() -> slackline.Call(
ApprovedList,
ApprovedListResponse,
)
admin.apps.approved.list:
List approved apps for an org or workspace.
apps.ApprovedList identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/approved_list.
User token scopes: admin.apps:read.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
feature_not_enabled, invalid_actor, invalid_cursor, not_allowed,
not_an_admin, restricted_action, team_not_found,
too_many_teams_provided.
pub fn approved_list_response_decoder() -> decode.Decoder(
ApprovedListResponse,
)
Decodes the response from admin.apps.approved.list.
pub fn channel_restriction_mode_decoder() -> decode.Decoder(
ChannelRestrictionMode,
)
Decodes ChannelRestrictionMode from a json string.
pub fn channel_restriction_mode_from_string(
string: String,
) -> ChannelRestrictionMode
Parses ChannelRestrictionMode from its json string.
pub fn channel_restriction_mode_to_json(
it: ChannelRestrictionMode,
) -> json.Json
Encodes ChannelRestrictionMode as a json string.
pub fn channel_restriction_mode_to_string(
it: ChannelRestrictionMode,
) -> String
The json string of ChannelRestrictionMode.
pub fn clear_resolution(
app_id app_id: String,
) -> slackline.Call(ClearResolution, Nil)
admin.apps.clearResolution:
Clear an app resolution
apps.ClearResolution identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/clear_resolution.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
feature_not_enabled, invalid_app_id, no_resolution_found,
not_an_admin, restricted_action, team_not_found,
too_many_teams_provided.
pub fn config_lookup() -> slackline.Call(
ConfigLookup,
ConfigLookupResponse,
)
admin.apps.config.lookup:
Look up the app config for connectors by their IDs
apps.ConfigLookup identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/config_lookup.
User token scopes: admin.apps:read.
Rate limit tier: t2.
Documented errors: missing_args.
pub fn config_lookup_response_decoder() -> decode.Decoder(
ConfigLookupResponse,
)
Decodes the response from admin.apps.config.lookup.
pub fn config_set(
app_id app_id: String,
) -> slackline.Call(ConfigSet, Nil)
admin.apps.config.set:
Set the app config for a connector
apps.ConfigSet identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/config_set.
User token scopes: admin.apps:write.
Rate limit tier: t3.
Documented errors: invalid_app, invalid_domains,
invalid_workflow_auth_strategy, no_domains_provided,
restricted_plan_level, too_many_domains_provided, unknown_method,
url_restriction_not_supported.
pub fn domain_restrictions_decoder() -> decode.Decoder(
DomainRestrictions,
)
Decodes DomainRestrictions from json.
pub fn domain_restrictions_to_json(
it: DomainRestrictions,
) -> json.Json
Encodes DomainRestrictions as json.
pub fn mcp_servers_list() -> slackline.Call(
McpServersList,
value.Value,
)
admin.apps.mcp.servers.list:
List third-party app MCP servers approved for an organization.
apps.McpServersList identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/mcp_servers_list.
User token scopes: admin.apps:read.
Rate limit tier: t3.
Documented errors: feature_not_enabled, invalid_cursor,
not_an_enterprise, restricted_action.
pub fn mcp_servers_permissions_list(
app_id app_id: String,
) -> slackline.Call(McpServersPermissionsList, value.Value)
admin.apps.mcp.servers.permissions.list:
List MCP servers for an app with their access control permissions.
apps.McpServersPermissionsList identifies this method in slackline.Call.
User token scopes: admin.apps:read.
Rate limit tier: t3.
Documented errors: app_not_found, not_an_enterprise,
restricted_action.
pub fn mcp_servers_permissions_set(
app_id app_id: String,
server_id server_id: String,
permission_type permission_type: AppPermissionType,
) -> slackline.Call(McpServersPermissionsSet, Nil)
admin.apps.mcp.servers.permissions.set:
Set the access control permission for who can use an MCP server.
apps.McpServersPermissionsSet identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/mcp_servers_permissions_set.
User token scopes: admin.apps:write.
Rate limit tier: t3.
Documented errors: app_not_found, entities_not_supported,
invalid_permission_type, named_entities_cannot_be_empty,
no_valid_named_entities, not_an_enterprise, restricted_action,
server_acl_entities_not_in_scope, server_acl_type_broader_than_app,
server_not_found, user_not_found, usergroup_not_found.
pub fn permissions_add(
app_id app_id: String,
) -> slackline.Call(PermissionsAdd, AppPermissions)
admin.apps.permissions.add:
Grant permission for entities to access an app that has its permission type
set to named_entities.
apps.PermissionsAdd identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/permissions_add.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_acl_not_found, app_not_found,
channel_not_found, failed_to_update_channels,
invalid_channel_restriction_mode, invalid_entities,
invalid_permission_type, no_valid_named_entities, not_an_enterprise,
restricted_action, too_many_named_entities, user_not_found.
pub fn permissions_list(
app_id app_id: String,
) -> slackline.Call(PermissionsList, AppPermissions)
admin.apps.permissions.list:
Returns the permission type of an app and the entities that have been
granted access.
apps.PermissionsList identifies this method in slackline.Call.
User token scopes: admin.apps:read.
Rate limit tier: t3.
Documented errors: app_not_found, invalid_permission_type,
not_an_enterprise, restricted_action.
pub fn permissions_remove(
app_id app_id: String,
) -> slackline.Call(PermissionsRemove, AppPermissions)
admin.apps.permissions.remove:
Revoke an entity’s access to an app that has its permission type set to
named_entities.
apps.PermissionsRemove identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/permissions_remove.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_acl_not_found, app_acl_write_failed,
app_not_found, channel_not_found, failed_to_update_channels,
invalid_channel_restriction_mode, invalid_permission_type,
named_entities_cannot_be_empty, not_an_enterprise, restricted_action,
too_many_named_entities, user_not_found.
pub fn permissions_set(
app_id app_id: String,
permission_type permission_type: AppPermissionType,
) -> slackline.Call(PermissionsSet, AppPermissions)
admin.apps.permissions.set:
Set the permission type for who can access an app.
apps.PermissionsSet identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/permissions_set.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_acl_write_failed, app_not_found,
channel_ids_required, channel_not_found,
channel_restriction_requires_app_access,
channel_restrictions_not_available, invalid_channel_restriction_mode,
invalid_permission_type, named_entities_cannot_be_empty,
no_valid_named_entities, not_an_enterprise, restricted_action,
too_many_named_entities, user_not_found, usergroup_not_found.
pub fn requests_cancel(
request_id request_id: String,
) -> slackline.Call(RequestsCancel, Nil)
admin.apps.requests.cancel:
Cancel app request for team
apps.RequestsCancel identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/requests_cancel.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
feature_not_enabled, invalid_request_id, not_an_admin,
request_already_resolved, restricted_action, team_not_found,
too_many_teams_provided.
pub fn requests_list() -> slackline.Call(
RequestsList,
RequestsListResponse,
)
admin.apps.requests.list:
List app requests for a team/workspace.
apps.RequestsList identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/requests_list.
User token scopes: admin.apps:read.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
enterprise_not_found, feature_not_enabled, invalid_cursor,
invalid_scopes, no_team_or_enterprise_provided, not_allowed,
not_an_admin, restricted_action, team_not_found,
too_many_teams_provided, user_is_restricted.
pub fn requests_list_response_decoder() -> decode.Decoder(
RequestsListResponse,
)
Decodes the response from admin.apps.requests.list.
pub fn resolved_app_decoder() -> decode.Decoder(ResolvedApp)
Decodes ResolvedApp from json.
pub fn resolved_app_to_json(it: ResolvedApp) -> json.Json
Encodes ResolvedApp as json.
pub fn restrict() -> slackline.Call(Restrict, Nil)
admin.apps.restrict:
Restrict an app for installation on a workspace.
apps.Restrict identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/restrict.
User token scopes: admin.apps:write.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
custom_integration_not_allowed_at_enterprise, feature_not_enabled,
invalid_app_id, invalid_request_id, invalid_scopes, not_an_admin,
request_already_resolved, request_id_or_app_id_is_required,
request_id_required_for_custom_integrations, team_not_found,
too_many_ids_provided, too_many_teams_provided.
pub fn restricted_list() -> slackline.Call(
RestrictedList,
RestrictedListResponse,
)
admin.apps.restricted.list:
List restricted apps for an org or workspace.
apps.RestrictedList identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/restricted_list.
User token scopes: admin.apps:read.
Rate limit tier: t2.
Documented errors: app_management_app_not_installed_on_org,
feature_not_enabled, invalid_actor, invalid_cursor, not_allowed,
not_an_admin, restricted_action, team_not_found,
too_many_teams_provided.
pub fn restricted_list_response_decoder() -> decode.Decoder(
RestrictedListResponse,
)
Decodes the response from admin.apps.restricted.list.
pub fn rich_link_preview_type_decoder() -> decode.Decoder(
RichLinkPreviewType,
)
Decodes RichLinkPreviewType from a json string.
pub fn rich_link_preview_type_from_string(
string: String,
) -> RichLinkPreviewType
Parses RichLinkPreviewType from its json string.
pub fn rich_link_preview_type_to_json(
it: RichLinkPreviewType,
) -> json.Json
Encodes RichLinkPreviewType as a json string.
pub fn rich_link_preview_type_to_string(
it: RichLinkPreviewType,
) -> String
The json string of RichLinkPreviewType.
pub fn uninstall(
app_id app_id: String,
) -> slackline.Call(Uninstall, Nil)
admin.apps.uninstall:
Uninstall an app from one or many workspaces, or an entire enterprise
organization.
apps.Uninstall identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/admin/apps/uninstall.
User token scopes: admin.apps:write.
Rate limit tier: t1.
Documented errors: app_not_found, can_not_uninstall,
enterprise_not_found, feature_not_enabled, must_revoke_access,
permission_denied, restricted_action, specify_enterprise_or_teams,
teams_not_found, too_many_teams.
pub fn workflow_auth_strategy_decoder() -> decode.Decoder(
WorkflowAuthStrategy,
)
Decodes WorkflowAuthStrategy from a json string.
pub fn workflow_auth_strategy_from_string(
string: String,
) -> WorkflowAuthStrategy
Parses WorkflowAuthStrategy from its json string.
pub fn workflow_auth_strategy_to_json(
it: WorkflowAuthStrategy,
) -> json.Json
Encodes WorkflowAuthStrategy as a json string.
pub fn workflow_auth_strategy_to_string(
it: WorkflowAuthStrategy,
) -> String
The json string of WorkflowAuthStrategy.