hot.dev/slack-admin / ::slack::admin::invite-requests

admin.inviteRequests.*: review workspace invite requests. With an org-level token, team_id is required.

Example

::invites ::slack::admin::invite-requests

pending ::invites/list(::invites/ListRequest({team_id: "T0123ABCDEF"}))
::invites/approve(::invites/ApproveRequest({invite_request_id: first(pending.invite_requests).id, team_id: "T0123ABCDEF"}))

Functions

approve

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

admin.inviteRequests.approve - Approve an invite request.

Scope: admin.invites: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.inviteRequests.approved.list - List approved invite requests (approved_requests).

Scope: admin.invites: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_requests entry from admin.inviteRequests.approved.list, following next_cursor until the last page or max-items (default 1000). request sets the filters; its cursor is the starting point.

denied-list

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

admin.inviteRequests.denied.list - List denied invite requests (denied_requests).

Scope: admin.invites: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 denied-list-all.

denied-list-all

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

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

deny

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

admin.inviteRequests.deny - Deny an invite request.

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

list

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

admin.inviteRequests.list - List pending invite requests (invite_requests).

Scope: admin.invites: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 list-all.

list-all

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

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

Types

ApproveRequest

ApproveRequest type {
    invite_request_id: Str,
    team_id: Str?
}

ApprovedListRequest

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

DeniedListRequest

DeniedListRequest type {
    team_id: Str?,
    cursor: Str?,
    limit: Int?
}

DenyRequest

DenyRequest type {
    invite_request_id: Str,
    team_id: Str?
}

ListRequest

ListRequest type {
    team_id: Str?,
    cursor: Str?,
    limit: Int?
}