API
Permissions

Permissions

Read the API Overview to get started and learn more.

Grant permission

Grants a permission to an user or role. The user/role is specified by which field (user_id or role_id) is set.

PUT
/
guilds
/
guildId
/
permissions
/
grant

Request body

FieldTypeDescription
permissionstringThe name of the permission. Must be one of bnders permissions
user_id (optional)stringId of the user that should get the permission granted
role_id (optional)stringId of the role that should get the permission granted
project_id (optional)stringId of the project the permission should be scoped to

Response body -

Returns a 204 status

Revoke permission

Revokes a permission from an user or role. The user/role is specified by which field (user_id or role_id) is set.

PUT
/
guilds
/
guildId
/
permissions
/
revoke

Request body

FieldTypeDescription
permissionstringThe name of the permission. Must be one of bnders permissions
user_id (optional)stringId of the user that should get the permission revoked
role_id (optional)stringId of the role that should get the permission revoked
project_id (optional)stringId of the project the permission should be scoped to

Response body -

Returns a 204 status

Apply permission preset

Applies a permission preset to an user or role (decided by the user_id or role_id field).

PUT
/
guilds
/
guildId
/
permissions
/
preset

Request body

FieldTypeDescription
presetstringName of the preset
user_id (optional)stringId of the user that should get the preset applied
role_id (optional)stringId of the role that should get the preset applied
project_id (optional)stringId of the project the permissions should be scoped to

Response body -

Returns a 204 status

Get a users permissions

Returns all permissions a user has.

GET
/
guilds
/
guildId
/
permissions
/
users
/
userId

Request body -

Response body

FieldTypeDescription
globalPermissionsMap<Permission, boolean>The permissions granted or revoked on a global scope
projectPermissionsMap<String, Map<Permission, boolean>>The permissions granted or revoked on a specific project
discordPermissionsstringThe discord permissions of the user

Returns a 200 status

Get a roles permissions

Returns all permissions a role has.

GET
/
guilds
/
guildId
/
permissions
/
roles
/
roleId

Request body -

Response body

FieldTypeDescription
globalPermissionsMap<Permission, boolean>The permissions granted or revoked on a global scope
projectPermissionsMap<String, Map<Permission, boolean>>The permissions granted or revoked on a specific project
discordPermissionsstringThe discord permissions of the role

Returns a 200 status

Social Media

X (Twitter)

Instagram

Discord

GitHub

YouTube

bnder logo