Organization unit groups

An organization unit can be any kind of department or part of an organization.

Group attributes

Attributes from VOOT Core

type

  • fc:orgunit

id

  • A unique identifier of the organization unit.

  • Example: "fc:org:uninett.no:unit:AVD-U20"

parent

  • Points to the identifier of the organization.

  • Example: "fc:org:uninett.no"

displayName

  • A human friendly name of the organization unit. Obtained from eduPersonOrgUnitDN:ou

  • Datatype: Translatable String

  • Example: "Department of Informatics"

description

  • A textual description of the group (optional). It may be translated as well.

  • Leave this field out rather than replicate the name of the organization.

  • Datatype: SCIM String

  • Example: "Research into all aspects of computing"

public

  • A boolean flag indicating whether the existence of this group and the basic group information is publicly available. It is always false for this group type.

  • Datatype: SCIM Boolean

  • Example: false

active

  • Will always be true for organization units that are currently active.

  • Datatype: SCIM Boolean

  • Example: true

Membership attributes

The user’s relationship to the group is expressed in a membership object. For organization unit groups, the object can contain the following attributes:

basic

  • This value may be member, admin or owner.

  • When populated from eduOrg/eduOrgUnit, this value is admin for employees, and member for all others.

  • Example: "member"

primaryOrgUnit

  • A boolean flag telling whether the current user is primarily affiliated with this org unit. A user will only have one primary affiliation to an org unit.

  • Datatype: SCIM Boolean

  • Example: true

Example:

{
    "displayName": "Avdeling for System og Mellomvare",
    "id": "fc:org:uninett.no:unit:AVD-U20",
    "parent": "fc:org:uninett.no",
    "type": "fc:orgunit",
    "membership": {
        "primaryOrgUnit": true,
        "basic": "member"
    },
    "public": false
}

Note

For primary and secondary education, the primaryOrgUnit membership attribute is replaced with primarySchool.