Brightspace Data Streams (July 2023)

Impersonation_Begin Event

«  Daily Course Access Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Impersonation_End Event  »

Impersonation_Begin EventΒΆ

Impersonation_Begin is posted when someone begins impersonating another user. The actor is the impersonator, and the object is the person being impersonated.

Note that during the time when User X is impersonating User Y, events will say that the actor is User Y, but the context information will contain an impersonatingUserId field identifying User X.

The Impersonation_Begin event object has the following form:

{
        "id": "<EventUUID>",
        "timestamp": "<UTCDateTimeString>",
        "actor": {
                "account": {
                        "homePage": "https://<TenantUUID>.lms.d2l.com/",
                        "name": "urn:uuid:<ImpersonatorUUID>"
                }
        },
        "verb": {
                "id": "https://api.brightspace.com/xapi/verbs/impersonation_started"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ImpersonatedUserUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/users/impersonation"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<OrgUnitUUID>",
                "extensions": {
                        "https://api.brightspace.com/xapi/extension_keys/context/actor": {
                                "userId": "<BrightspaceUserIdNumberForImpersonator>",
                                "roleId": "<BrightspaceRoleIdNumberForImpersonator>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "id": "<BrightspaceUserIdNumberForImpersonatedUser>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                                "orgUnitTypeId": "<BrightspaceOrgUnitTypeIdNumber",
                                "imsRoleIds": [ <IMSRoles> ]
                        }
                }
        }
}

Notes:

<OrgUnitUUID>

a unique identifier for the OrgUnit.

orgUnitTypeId

only present if the OrgUnit has been assigned a type ID number.

originalEventId

only provided for use by D2L personnel if needed for troubleshooting.

See Fundamental xAPI Concepts for information on other fields.

«  Daily Course Access Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Impersonation_End Event  »