Permissions
Read the API Overview to get started and learn more.
Grant a permission to a user or role
Grants the specified permission to a user or role, determined by the body content
PUT /guilds/guildId/permissions/grant
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| permission | string | The permission to apply |
| user_id (optional) | string | The user ID to apply the permission to |
| role_id (optional) | string | The role ID to apply the permission to |
| project_id (optional) | string | The project ID to apply the permission to |
Responses
204 Response (Permission granted): Empty response.
Revoke a permission from a user or role
Revokes the specified permission from a user or role, determined by the body content
PUT /guilds/guildId/permissions/revoke
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| permission | string | The permission to apply |
| user_id (optional) | string | The user ID to apply the permission to |
| role_id (optional) | string | The role ID to apply the permission to |
| project_id (optional) | string | The project ID to apply the permission to |
Responses
204 Response (Permission granted): Empty response.
Apply a permission preset to a user or role
Applies a permission preset to a user or role, determined by the body content
PUT /guilds/guildId/permissions/preset
Parameters
guildId The id of a discord guild
Request body
| Request Field | Type | Description |
|---|---|---|
| preset | string | The permission preset to apply |
| user_id (optional) | string | The user ID to apply the preset to |
| role_id (optional) | string | The role ID to apply the preset to |
| project_id (optional) | string | The project ID to apply the preset to |
Responses
204 Response (Preset applied): Empty response.
Get permissions of a role
Get all bnder permission for the specified role
GET /guilds/guildId/permissions/roles/roleId
Parameters
guildId The id of a discord guild
roleId The ID of the role
Responses
200 Response (Permissions retrieved):
| Response Field | Type | Description |
|---|---|---|
| globalPermissions | object | Global permissions are permissions that apply to all projects. They are not project-specific. |
| projectPermissions | object | Project permissions are permissions that apply to specific projects. They are project-specific. |
| discordPermissions | string | Discord permissions are permissions for discord. |
Get permissions of a user
Get all bnder permission for the specified user
GET /guilds/guildId/permissions/users/userId
Parameters
guildId The id of a discord guild
userId The ID of the user
Responses
200 Response (Permissions retrieved):
| Response Field | Type | Description |
|---|---|---|
| globalPermissions | object | Global permissions are permissions that apply to all projects. They are not project-specific. |
| projectPermissions | object | Project permissions are permissions that apply to specific projects. They are project-specific. |
| discordPermissions | string | Discord permissions are permissions for discord. |
