Skip to content

PATCH   /roles/{role}

Update permissions for a specific role

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

x-account-id   header string

Account ID for the request

role   path string

The role name to update permissions for

Optional Parameters

Click here to view an exhaustive list of all available parameters
accountId   query string

Account ID (required for SuperAdmin when operating on specific accounts)

Request Body

{
"flatPermissionsList": [
"string"
]
}

Try it out

Loading...

Output:

Responses

Description

Role permissions successfully updated

{
"message": "Role permissions updated"
}

References

#/components/parameters/xAccountIdHeader

in: header
name: x-account-id
schema:
type: string
description: Account ID for the request
required: true
example: "2311"

Route Source Code

Check out the source code for this route entrypoint here: /roles/[role]/route.ts

Or the swagger.yaml spec this documentation was generated from: /roles/swagger.yaml