Ctrl+K

FS cohort#

Group representing a cohort (kull) in a program of study (studieprogram).

Availability#

Attribute group

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

Organization type

This group type is available for higher education, where the organization has enabled the integration with Felles Studentsystem (FS).

Member list

Example#

{
  "id": "fc:fs:fs:kull:example.org:RF:2024H",
  "type": "fc:fs:kull",
  "displayName": "Kull for høst 2024 Rare fag",
  "membership": {
    "basic": "member",
    "active": true,
    "displayName": "Student",
    "fsroles": [
      "STUDENT"
    ],
    "notBefore": "2024-07-30T22:00:00Z",
    "notAfter": "2025-07-30T22:00:00Z"
  },
  "parent": "fc:fs:fs:prg:example.org:RF"
}

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:fs:fs:kull:<realm>:<program-of-study>:<cohort>. <realm> is the domain name of the organization. <program-of-study> is the identifier of the program of study. <cohort> is the identifier of the cohort within the program of study.

type (required, string)

The group type. Always the string fc:fs:prg for program of study groups.

displayName (required, string)

The name of the cohort.

membership (optional, object)

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

parent (required, string)

The id of the parent group. This is the group for the program of study.

Membership objects#

The membership object describes the role of the user in the cohort.

{
  "basic": "member",
  "active": true,
  "displayName": "Student",
  "fsroles": [
    "STUDENT"
  ],
  "notBefore": "2024-07-30T22:00:00Z",
  "notAfter": "2025-07-30T22:00:00Z"
}

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:

  • member: For students in the cohort.

active (required, boolean)

Whether the user is currently active in the group.

displayName (required, string)

A human readable descriptive name of the affiliation to the group.

fsroles (required, list of strings)

A list of roles from Felles studentsystem. E.g. ["STUDENT"].

notBefore (optional, string)

The date/time when the membership started.

notAfter (optional, string)

The date/time when the membership ended.

On this page