GroupMembership — cloud.docs

A membership to a group. A user ID can be used in place of a membership ID.

Properties

Name	Type	Required	Description
path	string	false	The resource path of the group membership. Format: `groups/{group_id}/memberships/{group_membership_id}`
createTime	string	false	The timestamp when the group membership was created.
updateTime	string	false	The timestamp when the group membership was last updated.
user	string	false	The resource path of a member of the group.
role	string	false	The resource path of the member's highest-ranked role. When the member holds multiple roles, this reflects only the highest-ranked one. Prefer using the `roles` field, which always contains the complete set of assigned roles.
roles	array	false	The resource paths of all roles assigned to the group member. This is the recommended field for reading a member's roles, as it always contains the complete set of roles held by the member.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "groups/123/memberships/123",
      "type": "string",
      "description": "The resource path of the group membership.\n\nFormat: `groups/{group_id}/memberships/{group_membership_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group membership was created.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group membership was last updated.",
      "format": "date-time"
    },
    "user": {
      "example": "users/21557",
      "type": "string",
      "description": "The resource path of a member of the group.",
      "x-immutable": true
    },
    "role": {
      "example": "groups/7/roles/99513316",
      "type": "string",
      "description": "The resource path of the member's highest-ranked role.\nWhen the member holds multiple roles, this reflects only the\nhighest-ranked one. Prefer using the `roles` field, which always\ncontains the complete set of assigned roles."
    },
    "roles": {
      "readOnly": true,
      "example": "groups/7/roles/99513316",
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The resource paths of all roles assigned to the group member.\nThis is the recommended field for reading a member's roles, as it\nalways contains the complete set of roles held by the member."
    }
  },
  "description": "A membership to a group. A user ID can be used in place of a membership ID.",
  "x-aep-resource": {
    "patterns": [
      "groups/{group_id}/memberships/{group_membership_id}"
    ],
    "plural": "group-memberships",
    "singular": "group-membership"
  },
  "x-resource": true
}