Discord

Publisher: Splunk
Connector Version: 1.0.2
Product Vendor: Discord
Product Name: Discord
Minimum Product Version: 6.3.0

Integrate with Discord to post messages and manage users in guilds

Configuration variables

This table lists the configuration variables required to operate Discord. These variables are specified when configuring a Discord asset in Splunk SOAR.

VARIABLE	REQUIRED	TYPE	DESCRIPTION
token	required	password	Discord bot token
guild_id	required	numeric	Server aka Guild ID

Supported Actions

test connectivity - Tests authorization with Discord
list channels - List text channels of a guild
send message - Send a message to the Discord channel
kick user - Kicks user from a guild
ban user - Bans user from a guild
fetch message - Gets information about the message
delete message - Removes a message from a channel
fetch message history - Gets information about the message
get user - Get information about a user of a Discord guild/server
on poll - Handles data ingestion from discord text channels

action: 'test connectivity'

Tests authorization with Discord

Type: test
Read only: True

Checks that the provided bot token is valid.

Action Parameters

No parameters are required for this action

Action Output

No Output

action: 'list channels'

List text channels of a guild

Type: investigate
Read only: True

The output of this action is a list of all text channels for the guild. The channels will be listed with their corresponding channel IDs.

Action Parameters

No parameters are required for this action

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.guild_id	string	`discord guild id`
action_result.data.*.id	string	`discord channel id`
action_result.data.*.name	string	`discord channel name`
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'send message'

Send a message to the Discord channel

Type: generic
Read only: False

Send a message to the Discord channel.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
destination	required	Discord channel ID to send message to	string	`discord channel id`
message	required	Message to send	string

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.destination	string	`discord channel id`
action_result.parameter.message	string
action_result.data.*.message_id	string	`discord message id`
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'kick user'

Kicks user from a guild

Type: correct
Read only: False

Kicks user from a guild.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
user_id	required	The ID of a user to kick from a guild	string	`discord user id`
reason	optional	The reason the user got kicked.	string

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.user_id	string	`discord user id`
action_result.parameter.reason	string
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'ban user'

Bans user from a guild

Type: correct
Read only: False

Bans user from a guild and deletes specific number of seconds worth of messages.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
user_id	required	The ID of a user to ban from a guild	string	`discord user id`
delete_message_seconds	optional	The number of seconds worth of messages to delete from the user in the guild. The minimum is 0 and the maximum is 604800 (7 days). Defaults to 1 day.	numeric
reason	optional	The reason the user got kicked.	string

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.user_id	string	`discord user id`
action_result.parameter.delete_message_seconds	numeric
action_result.parameter.reason	string
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'fetch message'

Gets information about the message

Type: investigate
Read only: True

Gets information about the message, such as: attachments, embeds, content, author, creation and edition date, it also shows jump url to the fetched message.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
channel_id	required	The ID of a channel to fetch message from	string	`discord channel id`
message_id	required	The ID of a message to get information of	string	`discord message id`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.channel_id	string	`discord channel id`
action_result.parameter.message_id	string	`discord message id`
action_result.data.*.message_origin.channel_id	numeric	`discord channel id`
action_result.data.*.message_origin.channel_name	string	`discord channel name`
action_result.data.*.message_data.created_at	numeric	`date`
action_result.data.*.message_data.edited_at	numeric	`date`
action_result.data.*.author_data.author_id	numeric	`author id` `discord user id`
action_result.data.*.author_data.author_name	string	`author name`
action_result.data.*.attachments	string	`artifact id`
action_result.data.*.embeds	string	`artifact id`
action_result.data.*.content	string	`message content`
action_result.data.*.jump_url	string	`url`
action_result.data.*.flags	string	`flags`
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'delete message'

Removes a message from a channel

Type: correct
Read only: False

Removes a message from a channel.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
channel_id	required	The ID of a channel to delete message from	string	`discord channel id`
message_id	required	The ID of a message to delete	string	`discord message id`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.channel_id	numeric	`discord channel id`
action_result.parameter.message_id	numeric	`discord message id`
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'fetch message history'

Gets information about the message

Type: investigate
Read only: True

Gets information about the message, from start data to end date.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
channel_id	required	The ID of a channel to fetch message history from	string	`discord channel id`
fetching_start_date	optional	Fetching start date (UTC): %Y-%m-%d %H:%M:%S	string	`date`
fetching_end_date	optional	Fetching end date (UTC): %Y-%m-%d %H:%M:%S	string	`date`
limit	optional	Limit of messages	numeric	`limit`
oldest_first	optional	Set to true for having oldest messages first	boolean

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.channel_id	numeric	`discord channel id`
action_result.parameter.fetching_start_date	string	`date`
action_result.parameter.fetching_end_date	string	`date`
action_result.parameter.limit	numeric	`limit`
action_result.parameter.oldest_first	boolean
action_result.data.*.message id	string	`discord message id`
action_result.data.*.author_id	string	`discord user id`
action_result.data.*.created at	string	`date`
action_result.data.*.embeds_attachments	string	`discord message embeds_attachments`
action_result.data.*.content	string	`message content`
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'get user'

Get information about a user of a Discord guild/server

Type: investigate
Read only: True

This action will get information about a user.

Action Parameters

PARAMETER	REQUIRED	DESCRIPTION	TYPE	CONTAINS
user_id	required	The ID of a user to get information of	string	`discord user id`

Action Output

DATA PATH	TYPE	CONTAINS
action_result.parameter.user_id	string	`discord user id`
action_result.data.*.display_name	string
action_result.data.*.name	string
action_result.data.*.created_at	string
action_result.data.*.system	string
action_result.data.*.public_flags	string
action_result.status	string
action_result.message	string
summary.total_objects	numeric
summary.total_objects_successful	numeric

action: 'on poll'

Handles data ingestion from discord text channels

Type: ingest
Read only: True

Handles data ingestion from discord text channels.

Action Parameters

No parameters are required for this action

Action Output

No Output

Auto-generated Splunk SOAR Connector documentation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Name		Name	Last commit message	Last commit date
Latest commit History 209 Commits
.github/workflows		.github/workflows
release_notes		release_notes
wheels		wheels
.pre-commit-config.yaml		.pre-commit-config.yaml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
__init__.py		__init__.py
discord.json		discord.json
discord.svg		discord.svg
discord_artifact.py		discord_artifact.py
discord_connector.py		discord_connector.py
discord_consts.py		discord_consts.py
discord_dark.svg		discord_dark.svg
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt
tox.ini		tox.ini

License

splunk-soar-connectors/discord

Folders and files

Latest commit

History

Repository files navigation

Discord

Configuration variables

Supported Actions

action: 'test connectivity'

Action Parameters

Action Output

action: 'list channels'

Action Parameters

Action Output

action: 'send message'

Action Parameters

Action Output

action: 'kick user'

Action Parameters

Action Output

action: 'ban user'

Action Parameters

Action Output

action: 'fetch message'

Action Parameters

Action Output

action: 'delete message'

Action Parameters

Action Output

action: 'fetch message history'

Action Parameters

Action Output

action: 'get user'

Action Parameters

Action Output

action: 'on poll'

Action Parameters

Action Output

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 5

Languages

Packages