FRfrontegg
Account roles

Get roles v2

This route returns all roles for vendor. Each role is an object containing the name, permissions, and other defining information.

get/resources/roles/v2

Request

Query parameters

_limitnumber
_sortBy'key' | 'name' | 'description' | 'isDefault' | 'firstUserRole' | 'level' | 'updatedAt' | 'createdAt' | 'permissions' | 'userTenants' | 'groups' required
_levelsnumber[]
_tenantIdsstring[]
_offsetnumber
_order'ASC' | 'DESC'
_filterstring

Headers

frontegg-tenant-idstring

For relating a role to a specific tenant, use get tenants API to find the tenant ids

Response

idstring required
vendorIdstring required
tenantIdstring required
keystring required
namestring required
descriptionstring required
isDefaultboolean required
firstUserRoleboolean required
levelnumber required
createdAtstring date-time required
updatedAtstring date-time required
permissionsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.