Ctrl+K

School owner group#

All Feide user accounts are associated with a single school owner. The school owner group contains information about the school owner.

Note

Both school owner and school groups have the same type attribute (fc:org). To recognize a school owner 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",
  "type": "fc:org",
  "displayName": "Eksempel kommune",
  "membership": {
    "basic": "admin",
    "displayName": "Lærer",
    "affiliation": ["member", "employee", "faculty"]
  },
  "public": false,
  "orgType": ["primary_and_lower_secondary_owner"],
  "eduOrgLegalName": "Eksempel kommune",
  "norEduOrgNIN": "NO123456789",
  "mail": "post@eksempel.kommune.no"
}

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>. <realm> is the domain name of the school owner.

type (required, string)

The group type. Always the string fc:org for school owner groups.

displayName (required, string)

The name of the organization.

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 school owner groups.

orgType (required, list of strings)

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

  • primary_and_lower_secondary_owner: The school owner has primary and lower secondary schools. (This is common for municipalities.)

  • upper_secondary_owner: The school owner has upper secondary schools. (This is common for counties.)

For most organizations this list contains a single entry, but some organizations (e.g. Oslo kommune) have multiple types.

eduOrgLegalName (required, string)

The official name of the organization.

It contains the eduOrgLegalName attribute in the organization object in the organization’s user directory.

norEduOrgNIN (required, string)

The organization number of the school owner. This is the organization number from the Brønnøysund Register Centre (Brønnøysundregisteret), prefixed with NO.

It contains the norEduOrgNIN attribute in the organization object in the organization’s user directory.

mail (required, string)

The email address of the organization.

It contains the mail attribute in the organization object in the organization’s user directory.

Optional group fields#

The following additional fields may be included from the organization object in the organization’s user directory: These fields are optional. If they are present, they will contain a single string.

  • eduOrgHomePageURI

  • eduOrgIdentityAuthNPolicyURI

  • eduOrgWhitePagesURI

  • facsimileTelephoneNumber

  • l

  • labeledURI

  • norEduOrgAcronym

  • norEduOrgUniqueIdentifier

  • postalAddress

  • postalCode

  • postOfficeBox

  • street

  • telephoneNumber

Membership objects#

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

{
  "basic": "admin",
  "displayName": "Lærer",
  "affiliation": ["member", "employee", "faculty"],
  "primaryAffiliation": "employee",
  "title": ["Lærer"]
}

It has the following fields:

basic (required, string)

The basic membership role of the user. This field is a string with one of the following values:

  • admin: For employees at the organization.

  • member: If the user is not an employee. (E.g. students.)

This field is derived from the affiliation field. A user is considered an employee if the affiliation list contains the employee value.

displayName (required, string)

A human-readable membership type. This field is derived from the affiliation field.

It contains a plain string. Typical values are:

  • Lærer

  • Stab

  • Ansatt

  • Elev

affiliation (required, list of strings)

A list of affiliations for the user. Teachers commonly have the values member, employee, and faculty. Students have member and student. Staff have member, employee, and staff.

Note

A user can be both student and teacher at the same time. In this case, the user has both the student and faculty affiliations:

{
  "basic": "admin",
  "displayName": "Lærer",
  "affiliation": ["member", "employee", "faculty", "student"]
}
primaryAffiliation (optional, string)

The primary affiliation of the user. This will be one of the values in the affiliation list.

This field is only present if the user has the eduPersonPrimaryAffiliation attribute in the organization’s user directory.

title (optional, list of strings)

The job title of the user. If the field is present, it will be a list with one or more strings.

This field is only present if the user has the title attribute in the organization’s user directory.

On this page