v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Roles

Delete organization role

Permanently removes a role from the organization and optionally reassigns users who had that role to a different role. Use this endpoint when you need to clean up unused roles or restructure your organization's access control system. If users are assigned to the role being deleted, you can provide a reassign_role_name to move those users to a different role before deletion. This action cannot be undone, so ensure no critical users depend on the role before deletion.

delete/api/v1/organizations/{org_id}/roles/{role_name}

Path parameters

org_idstring required

Unique identifier of the organization

role_namestring required

Unique name of the role

Query parameters

reassign_role_namestring

Role name to reassign users to when deleting this role

Response

Organization role successfully deleted and users reassigned if specified. No content returned.

{"stackTrail":"paths:/api/v1/organizations/{org_id}/roles/{role_name}:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}