Permissions

Set a team's custom role

Changed on

Gives a team one custom role (a team permission set), replacing its current one, or none with permissionSetId null. The same role can be given to any number of teams; a role left with no team is kept until it is deleted. You can only give a role whose permissions you all have yourself. Whether the team is an Admin team is changed separately (PATCH /v1/teams/:teamId). Requires permissions.manage (only the owner has it by default), a recent sign-in, and the Permissions and Shared roles features.

put/v1/teams/{teamId}/permission-set

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/teams/{teamId}/permission-set
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

teamIdstring typeid required

Den TypeID with 'tem_' prefix and a 26-character base32 suffix.

Request body

permissionSetIdstring typeid nullable required

Den TypeID with 'pms_' prefix and a 26-character base32 suffix.

Response

The team's custom role was set; the role's current state is returned, or null when the team has none.

Changes