Team / Team Roles /

Update team role

Updates a platform role for a team.

Required permission

Account > Admin > Roles > Manage

Path parameters

teamId
string required
ID of the team
roleId
string required
ID of the team role

Request body

{object}

name
string
The name of the role.
description
string
A description of the role.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
permissions
{object}
Permissions granted by this role.

teamScope
[array]
Team-level RBAC permission strings.

string

projectScope
[array]
Project-level RBAC permission strings.

string

restrictions
{object}
Project access restrictions for this role.

enabled
boolean required
Whether project restrictions are enabled.
projects
[array]
Project IDs this role is restricted to.

string

restrictionMode
string
Whether the restriction is inclusive or exclusive.
one of
in, not-in

members
[array]
Full list of user IDs assigned to this role.

string

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
ID of the role.
pattern
^[A-Za-z0-9-]+$
name
string required
Display name of the role.
description
string
Description of the role.
restrictions
{object} required

enabled
boolean required
Whether project restrictions are enabled.
projects
[array] required
Restricted project IDs.

string

restrictionMode
string
Restriction mode.

createdAt
string
Creation time.
updatedAt
string
Last updated.
permissions
{object} required

teamScope
[array] required
Team-level permissions.

string

projectScope
[array] required
Project-level permissions.

string

API

CLI

JS Client

PATCH /v1/teams/{teamId}/roles/{roleId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"name":"Developer","description":"Role for developers."}' \
  https://api.northflank.com/v1/teams/{teamId}/roles/{roleId}

Example response

200 OK

Details about the updated team role.

JSON

{
  "data": {
    "id": "developer",
    "name": "Developer",
    "description": "Role for developers.",
    "createdAt": "2021-01-20T11:19:53.175Z",
    "updatedAt": "2021-01-20T11:19:53.175Z"
  }
}