MEMBERSHIPS_GET

Sent when a tool asks for the roster of a course. Return every user in the requested context.

LTIAAS converts your role keys into LTI® role URLs and strips any personal data the tool is not allowed to see, so you can always send complete records.

Request: POST to your Service URL with a JSON body of { "payload": "<JWT>" }. Verify the JWT with your consumer public key, then read parameters.

The decoded payload:

{
  "type": "MEMBERSHIPS_GET",
  "parameters": {
    "context": "2022CSEa5e6c431b91",
    "clientId": "qR8E0iHqSdR30DdfQAbcaBGjKT65"
  }
}

application/json

Request Body required

payload string required

An RS256 JWT signed by LTIAAS, valid for ten minutes.

Responses

• 200

---

The roster for this context.

application/json

Schema

Example (from schema)

---

Schema

context object required
id string required
label string
title string
members object[] required
Array [
id string required
roles Role[] required
Possible values: [SYSTEM_ADMINISTRATOR, SYSTEM_NONE, SYSTEM_ACCOUNT_ADMIN, SYSTEM_CRETOR, SYSTEM_SYS_ADMIN, SYSTEM_SYS_SUPPORT, SYSTEM_USER, INSTITUTION_ADMINISTRATOR, INSTITUTION_FACULTY, INSTITUTION_GUEST, INSTITUTION_NONE, INSTITUTION_OTHER, INSTITUTION_STAFF, INSTITUTION_STUDENT, INSTITUTION_ALUMNI, INSTITUTION_INSTRUCTOR, INSTITUTION_LEARNER, INSTITUTION_MEMBER, INSTITUTION_MENTOR, INSTITUTION_OBSERVER, INSTITUTION_PROSPECTIVE, CONTEXT_ADMINISTRATOR, CONTEXT_CONTENT_DEVELOPER, CONTEXT_INSTRUCTOR, CONTEXT_LEARNER, CONTEXT_MENTOR, CONTEXT_MANAGER, CONTEXT_MEMBER, CONTEXT_OFFICER]
name string
givenName string
familyName string
middleName string
email string
]

{
  "context": {
    "id": "2022CSEa5e6c431b91",
    "label": "CS101",
    "title": "Computer Science 101"
  },
  "members": [
    {
      "id": "41",
      "roles": [
        "CONTEXT_LEARNER"
      ],
      "name": "John Doe",
      "givenName": "John",
      "familyName": "Doe",
      "middleName": "string",
      "email": "john.doe@myschool.com"
    }
  ]
}

Loading...