Names And Roles Membership Container

The Names & Roles Provisioning Service endpoint tools call to fetch a course roster. You never call this.

LTIAAS turns the call into a MEMBERSHIPS_GET service request against your Service URL, converts your reply into LTI® wire format, and filters out any personal data the tool is not permitted to see.

Requires an access token with the MEMBERSHIPS_READ scope.

Path Parameters

contextId string required
The URL-encoded context identifier — the same context value you supplied when starting the launch.
Example: 2022CSEa5e6c431b91

Responses

• 200
• 401
• 403

---

Membership container

application/vnd.ims.lti-nrps.v2.membershipcontainer+json

Schema

Example (from schema)

---

Schema

id uri
context object
id string required
label string
title string
members object[]
Array [
user_id string
roles uri[]
name string
given_name string
family_name string
middle_name string
email string
]

{
  "id": "string",
  "context": {
    "id": "2022CSEa5e6c431b91",
    "label": "CS101",
    "title": "Computer Science 101"
  },
  "members": [
    {
      "user_id": "string",
      "roles": [
        "string"
      ],
      "name": "string",
      "given_name": "string",
      "family_name": "string",
      "middle_name": "string",
      "email": "string"
    }
  ]
}

The Authorization header was missing, malformed, or carried the wrong key.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 401,
  "error": "Unauthorized",
  "details": {
    "message": "INVALID_BEARER_AUTHORIZATION_HEADER",
    "description": "Invalid API Key for account."
  }
}

The LTI® service this endpoint depends on is not enabled on your account.

application/json

Schema

Example (from schema)

Example

---

Schema

status integer
error string
details object

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

message string

description string

property name* any

Context for the failure. Always carries a message code; the other keys depend on what went wrong.

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "description": "string"
  }
}

{
  "status": 403,
  "error": "Forbidden",
  "details": {
    "message": "INACTIVE_SERVICE",
    "service": "Deep Linking"
  }
}

Loading...