Announcement
Account Roles API deprecated in favor of Permission Groups API
The Account Roles API is being deprecated and replaced by the Permission Groups API. Users need to migrate to the new API, which has a different response schema with meta objects and scopes instead of the legacy resource-keyed permissions structure.
The Account Roles API is deprecated and is being replaced by the Permission Groups API. An end of life date has not yet been established.
What you need to do
Review the Permission Groups API documentation; the response schema differs from the legacy Roles response.
Highlights
- Integrations migrating to the Permission Groups API must obtain Permission Group IDs from that API and use them in the Account Members API policies request shape. Integrations that persist legacy Role IDs will need to remap their assignments.
- The legacy
Roleresponse includes a top-leveldescriptionand apermissionsobject keyed by resource type with edit/read flags. - The
PermissionGroupresponse replaces those with ametaobject containinglabelandscopes. Individual permissions are not returned as part of the permission group. - The new API supports the API Token authorization scheme. The legacy Email + API Key authorization schema is provided for backwards compatibility.
For more information, refer to API deprecations.
apideprecationaccount-rolespermission-groupsmigration
Source: original entry ↗