Skip to content

Slash Commands Permissions #2737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 7, 2021
Merged

Slash Commands Permissions #2737

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b8c1ccc
Slash commands permissions
msciotti Mar 25, 2021
de4641a
Permissions example
msciotti Mar 25, 2021
d83b6a6
Casing
msciotti Mar 25, 2021
6e490a5
You are all very helpful and we appreciate you
msciotti Mar 25, 2021
38410f2
PR review
msciotti Apr 5, 2021
9bfef59
default_permissions DM behavior
msciotti Apr 5, 2021
3730106
Document proper response for permissions GET
msciotti Apr 5, 2021
ba84c27
PUT all guild command permissions
msciotti Apr 5, 2021
a57363a
typo
msciotti Apr 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Change_Log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Slash Command Permissions

## March XX, 2021
## April 5, 2021

Need to keep some of your Slash Commands safe from prying eyes, or only available to the right people? Slash Commands now support [command permissions](#DOCS_INTERACTIONS_SLASH_COMMANDS/permissions)!

Expand Down
24 changes: 15 additions & 9 deletions docs/interactions/Slash_Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,9 +632,9 @@ And, done! The JSON looks a bit complicated, but what we've ended up with is a s
Need to keep some of your Slash Commands safe from prying eyes, or only available to the right people? Slash Commands support permission overwrites for all your commands. For both guild _and_ global commands, you can enable or disable a specific user or role in a guild from using a command.

> info
> For now, disabled commands still show up in the command picker, but are unable to be used.
> For now, if you don't have permission to use a command, they'll show up in the command picker as disabled and unusable. They will not be hidden.

You can also set a `default_permission` on your commands if you want them to be disabled by default when your app is added to a new guild. Setting `default_permission` to `false` will disallow _anyone_ in a guild from using the command--even Administrators--unless a specific overwrite is configured.
You can also set a `default_permission` on your commands if you want them to be disabled by default when your app is added to a new guild. Setting `default_permission` to `false` will disallow _anyone_ in a guild from using the command--even Administrators and guild owners--unless a specific overwrite is configured.

For example, this command will not be usable by anyone in any guilds by default:

Expand All @@ -649,13 +649,17 @@ For example, this command will not be usable by anyone in any guilds by default:
To enable it just for a moderator role:

```py
MODERATOR_ROLE_ID = "173547401905176999"
MODERATOR_ROLE_ID = "<moderator_role_id"
url = "https://discord.com/api/v8/applications/<my_application_id>/guilds/<my_guild_id>/commands/<my_command_id>/permissions"

json = {
"id": MODERATOR_ROLE_ID,
"type": 1,
"permission": True
"permissions": [
{
"id": MODERATOR_ROLE_ID,
"type": 1,
"permission": True
}
]
}

headers = {
Expand All @@ -665,8 +669,6 @@ headers = {
r = requests.put(url, headers=headers, json=json)
```

The command will be visible to everyone, but disabled for everyone except the moderator role.

## Endpoints

> info
Expand All @@ -690,6 +692,7 @@ Create a new global command. New global commands will be available in all guilds
| name | string | 1-32 character name matching `^[\w-]{1,32}$` |
| description | string | 1-100 character description |
| options? | array of [ApplicationCommandOption](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommandoption) | the parameters for the command |
| default_permission? | boolean (default `true`) | whether the command is enabled by default when the app is added to a guild |

## Get Global Application Command % GET /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/commands/{command.id#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand}

Expand All @@ -709,6 +712,7 @@ Edit a global command. Updates will be available in all guilds after 1 hour. Ret
| name | string | 1-32 character name matching `^[\w-]{1,32}$` |
| description | string | 1-100 character description |
| options | array of [ApplicationCommandOption](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommandoption) | the parameters for the command |
| default_permission? | boolean (default `true`) | whether the command is enabled by default when the app is added to a guild |


## Delete Global Application Command % DELETE /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/commands/{command.id#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand}
Expand All @@ -733,6 +737,7 @@ Create a new guild command. New guild commands will be available in the guild im
| name | string | 1-32 character name matching `^[\w-]{1,32}$` |
| description | string | 1-100 character description |
| options? | array of [ApplicationCommandOption](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommandoption) | the parameters for the command |
| default_permission? | boolean (default `true`) | whether the command is enabled by default when the app is added to a guild |

## Get Guild Application Command % GET /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/commands/{command.id#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand}

Expand All @@ -752,6 +757,7 @@ Edit a guild command. Updates for guild commands will be available immediately.
| name | string | 1-32 character name matching `^[\w-]{1,32}$` |
| description | string | 1-100 character description |
| options | array of [ApplicationCommandOption](#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommandoption) | the parameters for the command |
| default_permission? | boolean (default `true`) | whether the command is enabled by default when the app is added to a guild |


## Delete Guild Application Command % DELETE /applications/{application.id#DOCS_TOPICS_OAUTH2/application-object}/guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/commands/{command.id#DOCS_INTERACTIONS_SLASH_COMMANDS/applicationcommand}
Expand Down Expand Up @@ -805,7 +811,7 @@ Edits command permissions for a specific command for your application in a guild

| Field | Type | Description |
| ----- | ---- | ----------- |
| permissions | array of [ApplicationCommandPermissions] |
| permissions | array of [ApplicationCommandPermissions] |

## Data Models and Types

Expand Down