Users API

The users API corresponds to the users resource of the SCIM API.

The edu-ID SCIM-User API also specifies the Users-Resource-API to create, modify and delete the personal part of an individual's identity. It is to be used only in special cases like during the migration of a organization from SWITCHaai to SWITCH edu-ID, or to manage technical accounts. Currently only the GET method is partially implemented.

Get the personal part of an edu-ID identity for a user who already has an edu-ID identity and whose edu-ID identifier swissEduPersonUniqueID is known. Here's a simplified example:

GET /scim/Users/9284756@eduid.ch

The service responds with a subset of the personal edu-ID attributes:

{
  "id":"9284756@eduid.ch",
  "userName":"9284756@eduid.ch",
  "urn:mace:switch.ch:eduid:scim:1.0:user" : {
    "swissEduPersonUniqueID" : "adfadsf8238u@test.eduid.ch",
    "swissEduIDAffiliations" : 
    [ 
      {
        "value" : "226611@unia.ch",
        "$ref" : "https://api.eduid.ch/scim/Affiliations/226611@unia.ch"
      }, 
      {
        "value" : "887733@unib.ch",
        "$ref" : "https://api.eduid.ch/scim/Affiliations/887733@unib.ch"
      } 
    ],
    "swissEduPersonAccountState" : "Active"
  }
}

The response contains the list of organizational Unique-IDs, which identifies the affiliations of a user. Details of an affiliation can be obtained by subsequent GET requests in the Affiliation API.

Legal Requirements

To use the Affiliation API an organization must be legally authorized. It is only allowed to access to data of their members, and it must obtain permission from their members to read and further process personal data.

Acccess to the Users-API is only granted to organizations that are legally authorized to do so.