Permissions

Replace team role

Changed on

Full-replace, idempotent update for role name, description, and permissions.

put/teams/{key}/roles/{roleId}

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/teams/{key}/roles/{roleId}
  • Auth: API key in header x-tenant-id

Path parameters

keystring required

Team identifier (ID or slug)

roleIdstring required

Unique permission role identifier

Request body

namestring required

Role display name

descriptionstring

Optional role description

permissionsstring[] required

Non-empty array of permission nodes. Supports wildcard and negation.

Example request

{
  "permissions": [
    "team.read",
    "team.member.write"
  ]
}

Response

OK

Example response

{
  "role": {
    "permissions": [
      "team.read",
      "team.member.write"
    ]
  }
}

Changes