Ctrl+K

FS program of study#

Group representing a program of study (studieprogram) in Felles Studentsystem (FS).

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:prg:example.org:RF",
  "type": "fc:fs:prg",
  "displayName": "Rare fag",
  "membership": {
    "basic": "member",
    "active": true,
    "displayName": "Student",
    "fsroles": [
      "STUDENT"
    ],
    "notBefore": "2024-07-30T22:00:00Z",
    "notAfter": "2025-07-30T22:00:00Z"
  },
  "url": "https://www.example.org/prg/rare-fag"
  "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:fs:fs:prg:<realm>:<program-of-study>. <realm> is the domain name of the organization. <program-of-study> is the identifier of 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 program of study.

membership (optional, object)

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

url (optional, string)

An URL to a description of the program of study.

parent (required, string)

The id of the parent group. This is the group for entire organization.

Membership objects#

The membership object describes the role of the user in the program of study.

{
  "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:

  • owner: For instructors, etc in the program of study.

  • member: For students in the program of study.

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