Ctrl+K

Organization unit group#

Information about organization units in higher education. These groups can provide information about organization units in higher education, such as institutes, faculties, departments, etc.

Note

it is not mandatory to register organization units for higher education organizations, so this information will not be available for many users.

Availability#

Attribute group

To retrieve these groups, the application needs access to the groups-org attribute group / scope.

Organization type

This group type is available for higher education.

Member list

Example#

{
  "id": "fc:org:example.org:unit:A42",
  "type": "fc:orgunit",
  "displayName": "Institutt for oddetallsfag",
  "membership": {
    "basic": "member",
    "primaryOrgUnit": false
  },
  "public": false,
  "parent": "fc:org:example.org"
}

Group object#

The group objects has the following fields:

id (required, string)

Unique identifier of the group. This is a string with the format fc:org:<realm>:unit:<orgunit-id>. <realm> is the domain name of the organization. <orgunit-id> is identifier of the organization unit.

type (required, string)

The group type. Always the string fc:orgunit for organization units in higher education.

displayName (required, string)

The name of the organization uit.

membership (optional, object)

The role of the current user in the group. This field is only present when requesting groups for a specific user.

public (required, boolean)

Whether this group is included in the list of public groups. This is always false for organization units in higher education.

parent (required, string)

The id of the parent organization group.

Membership objects#

The membership object describes the role of the user at the organization unit.

{
  "basic": "member",
  "primaryOrgUnit": true
}

It has the following fields:

basic (required, string)

The basic membership role of the user. This field is always member.

primaryOrgUnit (required, boolean)

Whether this is the primary organization unit of the user.

This is derived from the eduPersonPrimaryOrgUnitDN attribute in the user object in the organization’s user directory.

On this page