Group

Owned by Michal Šťava (Unlicensed)
Last updated: Aug 01, 2023 by Pavel Břoušek (Deactivated)
3 min read

Description:

Link: Group - Github

The purpose of an object Group is to create an organizational structure inside a Virtual organization. Every Group can have a set of child Groups (we refer to them as subGroups) and not more than one parent Group. A Group without a parent Group is referred to as a top-level group.

There is one exception:

  • A Group with the name “members” is a system Group in every Vo that contains all membership of users in relation to the Vo. It can’t be moved, updated, or deleted.

Memberships in the Group can be managed manually by managers or automatically by synchronization.

Lifecycle of membership in a Group supports these states of a membership:

  • ACTIVE

  • INACTIVE (it has expired or was changed manually)

Group can have related attributes:

  • group attributes

  • member-group attributes (attribute between an object Member and an object Group in relation)

  • group-resource attributes (attribute between an object Group and an object Resource in relation)

Related Roles:

  • Group Manager - Can do any operation with the Group (update, remove, move, include to other Group, change its attributes, etc.). The manager of a Group can also manage all subGroups on the lower levels of the tree (all subtrees).

  • Group Observer - Can see the Group and all its changeable properties and attributes. Can’t do any operation with the Group. This role is only for observing purposes. Observers of a Group can also see all subGroups on the lower levels of the tree (all subtrees).

Properties:

Name

Type

Description

Name

Type

Description

id

integer

Unique ID of the object Group inside the system PERUN. This property can’t be changed.

uuid

UUID

Standardized unique ID between all objects in one or more Perun instances.https://en.wikipedia.org/wiki/Universally_unique_identifier

This property can’t be changed.

parentGroupId

integer

Unique ID of the object Group is one level higher in the tree structure than this one. These groups are referred as “parent groups”. For example for the Group “A:B” the parent group is a Group with name “A” and its “id“ is saved in this property.

This property can be changed as a Group can be moved inside a Vo to any place in a tree structure.

voId

integer

Every object Group is limited to the object Vo where it was created. It can’t be moved outside of this space.

This property can’t be changed.

name

String

Also mentioned as “short name” is a unique name of a Group object inside a specific level of a tree structure where the Group has been created.

In default configuration (can be customizable changed to be even more strict) it allows only:

  • alphanumeric characters “A-Za-z”

  • numbers “0-9”

  • dash “-”

  • space “ “

  • underscore “_”

  • dot “.”

Character “:” is leading character which is not allowed because it defines a level of Group’s immersion in a tree structure (for example A:B:C where C is a subgroup of A:B and B is a subgroup of A)

The length of this property is not limited, but is it recommended to be minimalistic because of reasonable GUI capabilities to show the name of the object.

This property can be changed by updating a Group.

description

String

Any text can be saved into this property and it can be then used to identify purpose of a Group.

This property can be changed by updating a Group.

Related topics:

 

Support: perun@cesnet.cz