authority

Who or what asserts the statement's validity.

objectType

  • Flow resource path: statementData > authority > objectType

  • Parameter type: String text

  • Description: Specifies the type of authority that issued or authenticated the xAPI statement, such as "Agent" or "Group," defining its role in the statement.

Example

"authority": {
  "account": {},
  "objectType": "Agent",
  "name": "",
  "mbox": "",
  "openid": ""
}

name

  • Flow resource path: statementData > authority> name

  • Parameter type: String text

  • Description: The display name or identifier of the authority that issued or authenticated the xAPI statement.

Example

"authority": {
  "account": {},
  "objectType": "",
  "name": "Example name",
  "mbox": "",
  "openid": ""
}

mbox

  • Flow resource path: statementData > authority > mbox

  • Parameter type: String email

  • Description: Email address of the entity asserting the validity of the xAPI statement. You must choose either mbox, openid or account to match the data being sent to the flow. Authority shouldn’t contain more than one of these.

Example

"authority": {
  "account": {},
  "objectType": "",
  "name": "",
  "mbox": "example@example.com",
  "openid": ""
}

openid

  • Flow resource path: statementData > authority > openid

  • Parameter type: String URI

  • Description: OpenID identifier for the entity that authenticates the xAPI statement. You must choose either mbox, openid or account to match the data being sent to the flow. Authority shouldn’t contain more than one of these.

Example

"authority": {
  "account": {},
  "objectType": "",
  "name": "",
  "mbox": "",
  "openid": "https://www.example.com/123456"
}

account.name

  • Flow resource path: statementData > authority > account > name

  • Parameter type: String name

  • Description: Name of the account on a system or platform, attributed to the authority of the statement. You must choose either mbox, openid or account to match the data being sent to the flow. Authority shouldn’t contain more than one of these.

Example

"authority": {
  "account": {
    "homePage": "",
    "name": "000000340968"
  },
  "objectType": "",
  "name": "",
  "mbox": "",
  "openid": ""
}

account.homePage

  • Flow resource path: statementData > authority > account > homePage

  • Parameter type: String URL

  • Description: URL of the homepage or profile page for the authority's account on a platform. You must choose either mbox, openid or account to match the data being sent to the flow. Authority shouldn’t contain more than one of these.

Example

"authority": {
  "account": {
    "homePage": "https://www.example.com",
    "name": ""
  },
  "objectType": "",
  "name": "",
  "mbox": "",
  "openid": ""
}

Last updated