Workspace Roles

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getWorkspaceRoles",
  "title": "Workspace Roles",
  "type": "object",
  "description": "Information about the workspace's roles.",
  "properties": {
    "roles": {
      "type": "array",
      "description": "A list of workspace roles and the users and groups assigned to them.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The role's ID.",
            "example": "3"
          },
          "user": {
            "type": "array",
            "description": "A list of user IDs assigned to the role.",
            "items": {
              "type": "string",
              "description": "The user's ID or SCIM ID.",
              "example": "12345678"
            }
          },
          "group": {
            "type": "array",
            "description": "A list of user group IDs assigned to the role.",
            "items": {
              "type": "string",
              "description": "The group's ID.",
              "example": "123"
            }
          },
          "displayName": {
            "type": "string",
            "description": "The role's display name.",
            "enum": [
              "Admin",
              "Viewer",
              "Editor"
            ],
            "example": "Viewer"
          }
        }
      }
    }
  }
}