Ctrl+K

School group#

A Feide user account is associated with one or more schools. Each school group contains information about the school.

Note

Both school owner and school groups have the same type attribute (fc:org). To recognize a school group, check for a parent attribute. Only schools have a parent attribute.

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 primary, lower secondary and upper secondary schools.

Member list

Example#

{
  "id": "fc:org:eksempel.kommune.no:unit:NO987654321",
  "type": "fc:org",
  "displayName": "Eksempelskolen",
  "membership": {
    "basic": "member",
    "primarySchool": true
  },
  "public": false,
  "orgType": ["primary_and_lower_secondary"],
  "parent": "fc:org:eksempel.kommune.no"
}

Group object#

The group objects has the following fields:

id (required, string)

Unique identifier of the group. Has the format fc:org:<realm>:unit:<organization-number>. <realm> is the domain name of the school owner. <organization-number> is the organization number of the school, prefixed with NO.

Note

Some schools abroad do not have a Norwegian organization number. Instead they use an identifier like U87654321. This identifier comes from the national school register (NSR).

type (required, string)

The group type. Always fc:org for school groups.

displayName (required, string)

The name of the school.

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. Always false for school groups.

orgType (required, list of strings)

A list of organization types for this school. This list can have the following values:

  • primary_and_lower_secondary: The school is a primary or lower secondary school.

  • upper_secondary: The school is an upper secondary school.

For most schools this list contains a single entry. However, due to limitations in our data model, we include multiple values when the school owner has multiple types. E.g.: For Oslo kommune, all schools will have both primary_and_lower_secondary and upper_secondary.

parent (required, string)

The group identifier of the school owner.

Membership objects#

The membership object describes the role of the user at the school.

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

It has the following fields:

basic (required, string)

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

primarySchool (required, boolean)

Whether this is the primary school of the user.

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

On this page