FRfrontegg
Roles

Update role

This route updates an existing role. Add the role ID as a path parameter to the route url to specify which role you are updating. Send the updated information about the role in the PATCH body. Note that you do not update permissions for the role here. Use the attach permissions to role route to do that. Use the Get roles API to get the role ID.

patch/resources/roles/v1/{roleId}

Request

Path parameters

roleIdstring required

Headers

frontegg-tenant-idstring

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

Request body

isDefaultboolean

This role will be assigned for every user that will be added without specified roles

firstUserRoleboolean

This role will be assigned to the first user of a tenant (new tenants only)

migrateRoleboolean

Set this property to true together with isDefault in order to assign this role to all users

levelnumber

Role level for roles elevation, lower level means stronger role.

keystring
namestring
descriptionstring

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.