Skip to content

PUT   /roles/{role}

Force apply role permissions across accounts of a specific type (SuperAdmin only)

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

role   path string

The role name to update permissions for across accounts

accountId   query string

The account type ID

force   query string

Must be set to "true" to confirm this operation

Optional Parameters

Click here to view an exhaustive list of all available parameters
x-account-id   header string

The account ID for the request

Request Body

[
"string"
]

Try it out

Loading...

Output:

Responses

Description

Permissions successfully applied across accounts

{
"totalAccountsUpdated": 5,
"totalPermissionsCreated": 15
}

References

#/components/parameters/xAccountIdHeader

in: header
name: x-account-id
schema:
type: string
description: The account ID for the request
required: false

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