Get public interaction data

GET /api/experience/interaction

Get the public interaction data.

Responses

  • 200 application/json

    The public interaction data has been successfully retrieved.

    Hide response attributes Show response attributes object
    • interactionEvent string Required

      Values are SignIn, Register, or ForgotPassword.

    • userId string
    • profile object Required
      Hide profile attributes Show profile attributes object
      • avatar string | null

        Maximum length is 2048.

      • name string | null

        Maximum length is 128.

      • username string | null

        Maximum length is 128.

      • primaryEmail string | null

        Maximum length is 128.

      • primaryPhone string | null

        Maximum length is 128.

      • profile object
        Hide profile attributes Show profile attributes object
        • familyName string
        • givenName string
        • middleName string
        • nickname string
        • preferredUsername string
        • profile string
        • website string
        • gender string
        • birthdate string
        • zoneinfo string
        • locale string
        • address object
          Hide address attributes Show address attributes object
          • formatted string
          • streetAddress string
          • locality string
          • region string
          • postalCode string
          • country string
      • customData object

        arbitrary

      • socialIdentity object
        Hide socialIdentity attributes Show socialIdentity attributes object
      • enterpriseSsoIdentity object
        Hide enterpriseSsoIdentity attributes Show enterpriseSsoIdentity attributes object
        • identityId string Required

          Minimum length is 1, maximum length is 128.

        • ssoConnectorId string Required

          Minimum length is 1, maximum length is 128.

        • issuer string Required

          Minimum length is 1, maximum length is 256.

        • detail object Required

          arbitrary

      • syncedEnterpriseSsoIdentity object
        Hide syncedEnterpriseSsoIdentity attributes Show syncedEnterpriseSsoIdentity attributes object
        • identityId string Required

          Minimum length is 1, maximum length is 128.

        • issuer string Required

          Minimum length is 1, maximum length is 256.

        • detail object Required

          arbitrary

      • jitOrganizationIds array[string]
    • verificationRecords array[object]
      One of:
      object-1 object object-2 object object-3 object object-4 object object-5 object object-6 object object-7 object object-8 object object-9 object object-10 object
    • mfa object
      Hide mfa attributes Show mfa attributes object
      • mfaSkipped boolean
      • totp object
        Hide totp attribute Show totp attribute object
        • type string("Totp") Required
      • webAuthn array[object]
        Hide webAuthn attributes Show webAuthn attributes object
        • type string("WebAuthn") Required
        • credentialId string Required
        • publicKey string Required
        • transports array[string] Required

          Values are usb, nfc, ble, internal, cable, hybrid, or smart-card.

        • counter number Required
        • agent string Required
        • name string
      • backupCode object
        Hide backupCode attribute Show backupCode attribute object
        • type string("BackupCode") Required
    • captcha object
      Hide captcha attributes Show captcha attributes object
      • verified boolean Required
      • skipped boolean Required
GET /api/experience/interaction 
curl \
 --request GET 'https://[tenant_id].logto.app/api/experience/interaction'
Response examples (200) 
{
  "interactionEvent": "SignIn",
  "userId": "string",
  "profile": {
    "avatar": "string",
    "name": "string",
    "username": "string",
    "primaryEmail": "string",
    "primaryPhone": "string",
    "profile": {
      "familyName": "string",
      "givenName": "string",
      "middleName": "string",
      "nickname": "string",
      "preferredUsername": "string",
      "profile": "string",
      "website": "string",
      "gender": "string",
      "birthdate": "string",
      "zoneinfo": "string",
      "locale": "string",
      "address": {
        "formatted": "string",
        "streetAddress": "string",
        "locality": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    },
    "customData": {},
    "socialIdentity": {
      "target": "string",
      "userInfo": {
        "id": "string",
        "email": "string",
        "phone": "string",
        "name": "string",
        "avatar": "string",
        "rawData": {}
      }
    },
    "enterpriseSsoIdentity": {
      "identityId": "string",
      "ssoConnectorId": "string",
      "issuer": "string",
      "detail": {}
    },
    "syncedEnterpriseSsoIdentity": {
      "identityId": "string",
      "issuer": "string",
      "detail": {}
    },
    "jitOrganizationIds": [
      "string"
    ]
  },
  "verificationRecords": [
    {
      "id": "string",
      "type": "string",
      "identifier": {
        "type": "username",
        "value": "string"
      },
      "verified": true
    }
  ],
  "mfa": {
    "mfaSkipped": true,
    "totp": {
      "type": "string"
    },
    "webAuthn": [
      {
        "type": "string",
        "credentialId": "string",
        "publicKey": "string",
        "transports": [
          "usb"
        ],
        "counter": 42.0,
        "agent": "string",
        "name": "string"
      }
    ],
    "backupCode": {
      "type": "string"
    }
  },
  "captcha": {
    "verified": true,
    "skipped": true
  }
}