Box · Schema

Group membership

Membership is used to signify that a user is part of a group.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this group membership
type string `group_membership`
user object
group object
role string The role of the user in the group.
created_at string The time this membership was created.
modified_at string The time this membership was last modified.
View JSON Schema on GitHub

JSON Schema

box-groupmembership-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupMembership",
  "title": "Group membership",
  "type": "object",
  "x-box-resource-id": "group_membership",
  "x-box-tag": "memberships",
  "description": "Membership is used to signify that a user is part of a\ngroup.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this group membership",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`group_membership`",
      "example": "group_membership",
      "enum": [
        "group_membership"
      ]
    },
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user that the membership applies to"
        }
      ]
    },
    "group": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Group--Mini"
        },
        {
          "description": "The group that the membership applies to"
        }
      ]
    },
    "role": {
      "type": "string",
      "example": "member",
      "description": "The role of the user in the group.",
      "enum": [
        "member",
        "admin"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time this membership was created.",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time this membership was last modified.",
      "example": "2012-12-12T10:53:43-08:00"
    }
  }
}