Skip to main content
Version: 10.1

Role Event

Properties​

  • id (integer): Unique event identifier.

  • timestamp (string, format: date-time)

    Examples:

    "2018-11-13T20:20:39+00:00"
  • user (['string', 'null'], format: uri-reference): Optional resource of user who triggered the event.

    Examples:

    "/users/123"
  • event_type (string): Must be one of: ["role"].

  • event (string): Must be one of: ["create", "update", "delete"].

  • resource (string, format: uri-reference)

    Examples:

    "/roles/10"
  • parent_group (string, format: uri-reference): Direct parent group's resource.

    Examples:

    "/groups/12"
  • name (string): Descriptive role name.

  • description (string)

  • features (array): Permissions that this role allows for this role's parent group and descendents.

    • Items (object)
      • name (string)
      • privilege (string)
  • changes (object)

Examples​

{
"id": 1,
"timestamp": "2018-11-13T20:20:39+00:00",
"user": "/users/100",
"event_type": "role",
"event": "create",
"resource": "/roles/101",
"parent_group": "/groups/12",
"name": "Sample Role",
"description": "Sample Role Description",
"features": [
{
"name": "group",
"privilege": "rw"
},
{
"name": "group_admin",
"privilege": "none"
}
]
}