Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Role

Update Role

Updates an existing role

patch/roles/{roleId}

Path parameters

roleIdstring required

Headers

tenant-idstring

Request body

namestring

Role name

descriptionstring

Role description

Example request

{
  "name": "Business Admin",
  "description": "Full access to all operations"
}

Response

Role updated successfully

idstring

Role ID

namestring

Role name

tenantIdstring

Tenant ID

descriptionstring

Role description

createdAtstring date-time
updatedAtstring date-time
createdBystring

Created by

updatedBystring

Updated by

Example response

{
  "id": "role-123-456-789",
  "name": "Business Admin",
  "tenantId": "tenant-123-456-789",
  "description": "Full access to all operations",
  "createdAt": "2022-03-10T12:15:50-04:00",
  "updatedAt": "2022-03-10T12:15:50-04:00",
  "createdBy": "user-123-456-789",
  "updatedBy": "user-123-456-789"
}