Organization information

The organization information API provides access to information about organizations connected to Feide. This includes both host organizations (organizations whose users can log in using Feide) and service providers.

The organization information API is available under https://api.feide.no/2/org/

Data model

An organization object has the following structure:

{
  "id": "42",
  "name": {
    "en": "Example council",
    "nb": "Eksempel kommune",
    "nn": "Døme kommune"
  },
  "realm": "eksempel.kommune.no",
  "type": [
    "home_organization",
    "primary_and_lower_secondary"
  ],
  "count_auth": 538,
  "count_error_user": 146,
  "count_error_org": 30,
  "schema_version": "1.6"
}

id

The id-field contains the identifier of the organization in the Feide database.

name

This is the name of the organization. It is an object containing one key for each language we have the name in. The currently available languages are nb (Norwegian bokmål), nn (Norwegian nynorsk), se (Sami) and en (English). Not all languages are available for all organizations.

realm

The realm contains the realm of the users in the organization. This is the part after the @ in the eduPersonPrincipalName field in authentication responses from Feide.

This field is only applicable to home organizations. For service providers it will be null.

type

The types of the organization. This is a list containing the differnt categories of the organization. The following types are available:

  • higher_education: A university or university college.
  • home_organization: A home organization, which is an organization whose users can log into Feide services.
  • primary_and_lower_secondary: A organization providing primary and lower secondary schools. Typically municipalities, but also includes private schools.
  • service_provider: An organization providing one or more services.
  • upper_secondary: A organization providing upper secondary schools. Mainly county councils, but also includes private schools.

count_auth

The number of authentications done by users at the organization the last week.

count_error_user

The number of authentications with errors in information about the user during the same time period as count_auth.

The information is validated against the requirements in the schema_version presented by the organization.

count_error_org

The number of authentications with errors in information about the organization and organization units during the same time period as count_auth.

The information is validated against the requirements in the schema_version presented by the organization.

schema_version

Feide schema version used by the organization.

Available endpoints

There are two endpoints available for organization data, one for retrieving all organizations, and one for fetching a single organization

Fetching all organizations

URL: https://api.feide.no/2/org/all

This returns a JSON array containing all organizations.

Fetching a single organization

URL: https://api.feide.no/2/org/ORG-ID

This returns a JSON object for the single organization with the id ORG-ID If the organization does not exist, a “404 Not Found” error is returned.

Fields returned

By default endpoints return id, name, realm and type.

If you want to get the other fields or customize what is returned use the request parameter fields and comma-separate the fields you want returned.

URL: https://api.feide.no/2/org/all?fields=id,name,schema_version

URL: https://api.feide.no/2/org/ORG-ID?fields=realm,name,count_auth