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

admin.apps.*: approve, restrict or uninstall apps; review install requests; read app activity logs; and read or set app configuration. Approve/restrict take either app_id or request_id, scoped by team_id (workspace) or enterprise_id (org).

Example

::apps ::slack::admin::apps

pending ::apps/requests-list(::apps/RequestsListRequest({team_id: "T0123ABCDEF"}))
::apps/approve(::apps/ApproveRequest({request_id: first(pending.app_requests).id, team_id: "T0123ABCDEF"}))

Functions

activities-list

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

admin.apps.activities.list - Read app activity logs (activities). Filter by component_type (events_api, workflows, functions, tables), min_log_level, and a time range in epoch microseconds.

Scope: admin.app_activities:read. Returns Slack's response body; ok: false comes back as an Err(SlackError). Cursor-paginated: pass cursor from response_metadata.next_cursor, or use activities-list-all.

activities-list-all

fn (): Vec
fn (request: ActivitiesListRequest): Vec
fn (request: ActivitiesListRequest, max-items: Int): Vec
fn (request: ActivitiesListRequest, max-items: Int, opts: Map): Vec

Every activities entry from admin.apps.activities.list, following next_cursor until the last page or max-items (default 1000). request sets the filters; its cursor is the starting point.

approve

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

admin.apps.approve - Approve an app (by app_id) or an install request (by request_id).

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

approved-list

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

admin.apps.approved.list - List approved apps (approved_apps).

Scope: admin.apps:read. Returns Slack's response body; ok: false comes back as an Err(SlackError). Cursor-paginated: pass cursor from response_metadata.next_cursor, or use approved-list-all.

approved-list-all

fn (): Vec
fn (request: ApprovedListRequest): Vec
fn (request: ApprovedListRequest, max-items: Int): Vec
fn (request: ApprovedListRequest, max-items: Int, opts: Map): Vec

Every approved_apps entry from admin.apps.approved.list, following next_cursor until the last page or max-items (default 1000). request sets the filters; its cursor is the starting point.

clear-resolution

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

admin.apps.clearResolution - Clear an app's approved/restricted status.

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

config-lookup

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

admin.apps.config.lookup - Read app configuration (domain restrictions, workflow auth strategy).

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

config-set

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

admin.apps.config.set - Set app configuration. domain_restrictions: {urls?, emails?}; workflow_auth_strategy: builder_choice or end_user_only.

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

requests-cancel

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

admin.apps.requests.cancel - Cancel an install request.

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

requests-list

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

admin.apps.requests.list - List pending install requests (app_requests).

Scope: admin.apps:read. Returns Slack's response body; ok: false comes back as an Err(SlackError). Cursor-paginated: pass cursor from response_metadata.next_cursor, or use requests-list-all.

requests-list-all

fn (): Vec
fn (request: RequestsListRequest): Vec
fn (request: RequestsListRequest, max-items: Int): Vec
fn (request: RequestsListRequest, max-items: Int, opts: Map): Vec

Every app_requests entry from admin.apps.requests.list, following next_cursor until the last page or max-items (default 1000). request sets the filters; its cursor is the starting point.

restrict

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

admin.apps.restrict - Restrict an app (by app_id) or deny an install request (by request_id).

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

restricted-list

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

admin.apps.restricted.list - List restricted apps (restricted_apps).

Scope: admin.apps:read. Returns Slack's response body; ok: false comes back as an Err(SlackError). Cursor-paginated: pass cursor from response_metadata.next_cursor, or use restricted-list-all.

restricted-list-all

fn (): Vec
fn (request: RestrictedListRequest): Vec
fn (request: RestrictedListRequest, max-items: Int): Vec
fn (request: RestrictedListRequest, max-items: Int, opts: Map): Vec

Every restricted_apps entry from admin.apps.restricted.list, following next_cursor until the last page or max-items (default 1000). request sets the filters; its cursor is the starting point.

uninstall

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

admin.apps.uninstall - Uninstall an app from workspaces (team_ids) or the whole org (enterprise_id).

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

Types

ActivitiesListRequest

ActivitiesListRequest type {
    app_id: Str?,
    team_id: Str?,
    component_id: Str?,
    component_type: Str?,
    log_event_type: Str?,
    min_log_level: Str?,
    min_date_created: Int?,
    max_date_created: Int?,
    sort_direction: Str?,
    source: Str?,
    trace_id: Str?,
    cursor: Str?,
    limit: Int?
}

ApproveRequest

ApproveRequest type {
    app_id: Str?,
    request_id: Str?,
    team_id: Str?,
    enterprise_id: Str?
}

ApprovedListRequest

ApprovedListRequest type {
    team_id: Str?,
    enterprise_id: Str?,
    certified: Bool?,
    cursor: Str?,
    limit: Int?
}

ClearResolutionRequest

ClearResolutionRequest type {
    app_id: Str,
    team_id: Str?,
    enterprise_id: Str?
}

ConfigLookupRequest

ConfigLookupRequest type {
    app_ids: Vec<Str>
}

ConfigSetRequest

ConfigSetRequest type {
    app_id: Str,
    domain_restrictions: Map?,
    workflow_auth_strategy: Str?
}

RequestsCancelRequest

RequestsCancelRequest type {
    request_id: Str,
    team_id: Str?,
    enterprise_id: Str?
}

RequestsListRequest

RequestsListRequest type {
    team_id: Str?,
    enterprise_id: Str?,
    certified: Bool?,
    cursor: Str?,
    limit: Int?
}

RestrictRequest

RestrictRequest type {
    app_id: Str?,
    request_id: Str?,
    team_id: Str?,
    enterprise_id: Str?
}

RestrictedListRequest

RestrictedListRequest type {
    team_id: Str?,
    enterprise_id: Str?,
    certified: Bool?,
    cursor: Str?,
    limit: Int?
}

UninstallRequest

UninstallRequest type {
    app_id: Str,
    team_ids: Vec<Str>?,
    enterprise_id: Str?
}