Permission Roles

Create role

post /api/http/permission-roles/create

Create new custom permission role in specified permission context

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

object with fields:

contextIdentifier: PermissionContextIdentifier ( Required )
name: string ( Required )

Response
`RoleDTO`

Get roles

post /api/http/permission-roles/get

List all permission roles in permission context

Required permissions: Grant permissions to other members, View project details, View channel info

Request arguments

object with fields:

contextIdentifier: PermissionContextIdentifier ( Required )

Response
array of `RoleDTO`

Reset role permissions to default

post /api/http/permission-roles/{roleId}/reset-role-permissions-to-default

Reset permissions for the role to the standard ones. Only applicable to roles with PermissionRoleType = PREDEFINED, not applicable to custom roles.

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments
`roleId`: `string` (Path) ( Required )

Response
No arguments

Update role

patch /api/http/permission-roles/{roleId}

Update custom permission role name

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

object with fields:

name: string ( Required )

Response
No arguments

Delete role

delete /api/http/permission-roles/{roleId}

Delete custom permission role

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments
`roleId`: `string` (Path) ( Required )

Response
No arguments

Get 2fa requirement

get /api/http/permission-roles/{roleId}/2-fa-requirement

Get 2FA requirement for permission role

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments
`roleId`: `string` (Path) ( Required )

Response
`TwoFactorAuthenticationRequirement`

Set 2fa requirement

patch /api/http/permission-roles/{roleId}/2-fa-requirement

Set 2FA requirement for permission role

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

object with fields:

required: boolean ( Nullable and Optional , defaults to null)

Response
No arguments

Grant role permissions

post /api/http/permission-roles/{roleId}/permissions

Grant permissions to the specified role. You can get the list of all permissions applicable to the role using " Get all " method.

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

object with fields:

rightCodes: array of string ( Required )

Response
No arguments

Get role permissions

get /api/http/permission-roles/{roleId}/permissions

Get role permissions

Required permissions: Grant permissions to other members, View project details, View channel info

Request arguments
`roleId`: `string` (Path) ( Required )

Response
array of `RightDTO`

Revoke role permissions

delete /api/http/permission-roles/{roleId}/permissions

Revoke permissions from the specified role.

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments
`roleId`: `string` (Path) ( Required )
`rightCodes`: array of `string` (Query) ( Required )

Response
No arguments

Add role member

post /api/http/permission-roles/{roleId}/profiles/{profile}

Assign permission role to the profile

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path) ( Required )

Response
No arguments

Remove role member

delete /api/http/permission-roles/{roleId}/profiles/{profile}

Remove permission role from the profile

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path) ( Required )

Response
No arguments

Get role members

get /api/http/permission-roles/{roleId}/profiles

Get list of profiles with the specified role

Required permissions: Grant permissions to other members, View project details, View channel info

Request arguments
`roleId`: `string` (Path) ( Required )

Response
array of `TD_MemberProfile`

Add role team

post /api/http/permission-roles/{roleId}/teams/{team}

Assign permission role to the team

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

team: string in one of the formats

externalId: string
id: string
name: string

(Path) ( Required )

Response
No arguments

Remove role team

delete /api/http/permission-roles/{roleId}/teams/{team}

Remove permission role from the team

Required permissions: Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

roleId: string (Path) ( Required )

team: string in one of the formats

externalId: string
id: string
name: string

(Path) ( Required )

Response
No arguments

Get role teams

get /api/http/permission-roles/{roleId}/teams

Get list of teams with the specified role

Required permissions: Grant permissions to other members, View project details, View channel info

Request arguments
`roleId`: `string` (Path) ( Required )

Response
array of `TD_Team`

Last modified: 06 September 2023