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" ]}{ "flatPermissionsList": [ "string" ]}Try it out
Loading...
Output:
Responses
Description
Role permissions successfully updated
{ "message": "Role permissions updated"}Description
Invalid request body or invalid permissions
Description
Unauthorized access
Description
No permission (requires account admin privileges)
Description
Role not found
Description
Internal server error
References
#/components/parameters/xAccountIdHeader
in: headername: x-account-idschema: type: stringdescription: Account ID for the requestrequired: trueexample: "2311"|export type xAccountIdHeader = any; // Schema type not fully supportedRoute 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