freshworks · Schema

Role

Properties

Name	Type	Description
id	integer	Unique ID of the role.
name	string	Name of the role.
description	string	Description of the role.
default	boolean	Whether this is a default system role.
created_at	string	Timestamp when the role was created.
updated_at	string	Timestamp when the role was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Role",
  "title": "Role",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the role."
    },
    "name": {
      "type": "string",
      "description": "Name of the role."
    },
    "description": {
      "type": "string",
      "description": "Description of the role."
    },
    "default": {
      "type": "boolean",
      "description": "Whether this is a default system role."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the role was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the role was last updated."
    }
  }
}