RoleResponse

Full role record returned from create, read, or update operations

Properties

Name	Type	Description
id	integer	Unique numeric identifier of the role
name	string	Role name
description	string	Role description
permissions	array	Permissions granted by this role
createdBy	integer	ID of the user who created the role
createdOn	string	ISO 8601 timestamp when the role was created
updatedBy	integer	ID of the user who last modified the role
updatedOn	string	ISO 8601 timestamp of the last update

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleResponse",
  "title": "RoleResponse",
  "type": "object",
  "description": "Full role record returned from create, read, or update operations",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique numeric identifier of the role"
    },
    "name": {
      "type": "string",
      "description": "Role name"
    },
    "description": {
      "type": "string",
      "description": "Role description"
    },
    "permissions": {
      "type": "array",
      "description": "Permissions granted by this role",
      "items": {
        "$ref": "#/components/schemas/Permission"
      }
    },
    "createdBy": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the user who created the role"
    },
    "createdOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the role was created"
    },
    "updatedBy": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the user who last modified the role"
    },
    "updatedOn": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of the last update"
    }
  }
}