interface Group {
    _links?: GenericLinks;
    id: string;
    managedBy?:
        | "ADMINS"
        | "EXTERNAL"
        | "TEAM_MEMBERS"
        | "OPEN";
    name: string;
    type: "group";
    usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION";
}

Hierarchy

  • Record<string, unknown>
    • Group

Properties

_links?: GenericLinks
id: string
managedBy?:
    | "ADMINS"
    | "EXTERNAL"
    | "TEAM_MEMBERS"
    | "OPEN"

This property represents how this collection of users is managed:

  • ADMINS: This value indicates that the collection of users is managed by org, site or product admins.
  • EXTERNAL: This value indicates that the collection of users is managed externally (through SCIM, HRIS, etc.).
  • TEAM_MEMBERS: This value indicates that the collection of users is managed by its members.
  • OPEN: This value indicates that the collection of users is not actively managed by any users.
name: string
type
usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION"

This property represents how this collection of users is used:

  • USERBASE_GROUP: This value indicates that the collection of users is used as a group.
  • TEAM_COLLABORATION: This value indicates that the collection of users is used as a team.