Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Role

Create a new role for a tenant

Creates a new role under the tenant identified by the required tenant-id header. Use this to define a named grouping of permissions that can later be assigned to users; to modify an existing role use PATCH /roles/{roleId}. The request body accepts a name and an optional description for the new role. Returns 201 with the created role object including the server-assigned id, tenantId, createdAt, and createdBy fields. Returns 400 if the tenant-id header is absent or blank.

post/roles

Headers

tenant-idstring

Request body

namestring required

Role name

descriptionstring

Role description

Example request

{
  "name": "Credentialing Reviewer",
  "description": "Read-only access to credentialing workflows and audit logs"
}

Response

Role created successfully

idstring

Role ID

namestring

Role name

tenantIdstring

Tenant ID

descriptionstring

Role description

createdAtstring date-time
updatedAtstring date-time
createdBystring

ID of the user who created the role

updatedBystring

ID of the user who last updated the role

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Business Admin",
  "tenantId": "8f14e45f-ceea-467e-9906-ccfb98d21f95",
  "description": "Full access to all operations",
  "createdAt": "2022-03-10T12:15:50-04:00",
  "updatedAt": "2022-03-10T12:15:50-04:00",
  "createdBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11",
  "updatedBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11"
}