Last updated on December 9, 2025

IAM Service Account Events 0.1.0 documentation

Protobuf File Spec: iam.proto

Published Messages (userAccount)

The service publishes one of these messages below.

`userAccountCreated`

Message is sent when publisher user account is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountDeleted`

Message is sent when user account is deleted. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountEnabled`

Message is sent when user account is enabled. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountDisabled`

Message is sent when user account is disabled. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountEmailUpdated`

Message is sent when user change own email/admin change user's email, email is not verified yet. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountPasswordUpdated`

Message is sent when user update password. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountBanned`

Message is sent when user is banned. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountBan": {
      "ban": [
        {
          "banId": "string",
          "targetNamespace": "string",
          "targetUserId": "string",
          "name": "string",
          "reason": "string",
          "comment": "string",
          "enabled": true,
          "endDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountBan	userAccountBan	-

`userAccountUnbanned`

Message is sent when user is unbanned. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userAccountBan": {
      "ban": [
        {
          "banId": "string",
          "targetNamespace": "string",
          "targetUserId": "string",
          "name": "string",
          "reason": "string",
          "comment": "string",
          "enabled": true,
          "endDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userAccountBan	userAccountBan	-

`userAccountVerified`

Message is sent when user account is verified. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAccountStatus	userAccountStatus	-
namespace	string	namespace
userId	string	user id

`userAccountLinked`

Message is sent when user account is linked to a third party platform. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "namespace": "string",
      "userId": "string",
      "emailAddress": "string",
      "testAccount": true,
      "publisherNamespace": "string",
      "publisherUserId": "string"
    },
    "userAccountThirdParty": {
      "platformId": "string",
      "platformUserId": "string",
      "platformDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	object	-
userAccountThirdParty	object	-

`payload.userAccount`

Name	Type	Description
namespace	string	target namespace
userId	string	user id
emailAddress	string	email address
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account
publisherNamespace	string	publisher namespace
publisherUserId	string	publisher user id

`payload.userAccountThirdParty`

Name	Type	Description
platformId	string	third party platform id
platformUserId	string	third party platform user id
platformDisplayName	string	third party platform user display name

`userAccountUnlinked`

Message is sent when user account and third party platform are unlinked. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "testAccount": true,
      "namespace": "string",
      "linkedAccounts": [
        {
          "userId": "string",
          "emailAddress": "string",
          "userName": "string",
          "country": "string",
          "namespace": "string",
          "platformId": "string",
          "displayName": "string"
        }
      ]
    },
    "userAccountThirdParty": {
      "platformId": "string",
      "platformUserId": "string",
      "platform": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	object	-
userAccountThirdParty	object	-

`payload.userAccount`

Name	Type	Description
userId	string	publisher user id
emailAddress	string	email address
targetNamespace	string	target namespace
targetUserId	string	target user id in target namespace
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account
namespace	string	publisher namespace
linkedAccounts	array of userAccount	game accounts in the game namespaces where the account link happened

`payload.userAccountThirdParty`

Name	Type	Description
platformId	string	third party platform id
platformUserId	string	third party platform user id
platform	string	third party platform, it can be the platform id or the account group name

`userAccountUpgraded`

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "publisherUserId": "string",
      "namespace": "string",
      "testAccount": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	object	-

`payload.userAccount`

Name	Type	Description
userId	string	user id
emailAddress	string	user email address
publisherUserId	string	publisher user id
namespace	string	namespace
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account

`gameUserAccountCreated`

Message is sent when user account in game namespace is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "gameNamespace": "string",
      "country": "string",
      "testAccount": true
    },
    "userAccountStatus": {
      "deletionStatus": true,
      "enabled": true,
      "verified": true
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	object	-
userAccountStatus	userAccountStatus	-
namespace	string	-
userId	string	-

`payload.userAccount`

Name	Type	Description
userId	string	game user id in game namespace
emailAddress	string	email address
gameNamespace	string	game namespace
country	string	user country
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account

`thirdPartyAccountCreated`

Message is sent when a third party is linked to an account or first login. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "thirdParty": {
      "userId": "string",
      "thirdPartyUserId": "string",
      "platformId": "string",
      "namespace": "string",
      "displayName": "string",
      "country": "string",
      "emailAddress": "string"
    },
    "namespace": "string",
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
thirdParty	object	-
namespace	string	publisher namespace
userId	string	publisher user id

`payload.thirdParty`

Name	Type	Description
userId	string	publisher user id
thirdPartyUserId	string	third party platform user id
platformId	string	third party platform id
namespace	string	namespace
displayName	string	synced from third party, gamer tag for xbox/online id for psn, etc
country	string	country
emailAddress	string	third party platform email address

`userAccountTypeChanged`

Message is sent when user's account type is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "namespace": "string",
      "testAccount": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	object	-

`payload.userAccount`

Name	Type	Description
userId	string	user id
namespace	string	namespace
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account

Published Messages (userAuthentication)

The service publishes one of these messages below.

`userLoggedIn`

Message is sent when user login with a username/email and password. For logins using third-party accounts or device login, please refer to userThirdPartyLoggedIn. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAuthentication": {
      "platformId": "string",
      "refresh": true,
      "platformUserId": "string",
      "simultaneousPlatformId": "string",
      "simultaneousPlatformUserId": "string"
    },
    "loginLocation": {
      "country": "string",
      "state": "string",
      "city": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAuthentication	userAuthentication	-
loginLocation	loginLocation	-

`userLoggedOut`

Message is sent when user logout. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAuthentication": {
      "platformId": "string",
      "refresh": true,
      "platformUserId": "string",
      "simultaneousPlatformId": "string",
      "simultaneousPlatformUserId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAuthentication	userAuthentication	-

`userThirdPartyLoggedIn`

Message is sent when user login with a third party account or through device login. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAuthentication": {
      "platformId": "string",
      "refresh": true,
      "platformUserId": "string",
      "simultaneousPlatformId": "string",
      "simultaneousPlatformUserId": "string"
    },
    "loginLocation": {
      "country": "string",
      "state": "string",
      "city": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAuthentication	userAuthentication	-
loginLocation	loginLocation	-

`userLoginFailed`

Message is sent when user login failed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAuthenticationFailed": {
      "category": "string",
      "clientName": "string",
      "country": "string",
      "detail": "string",
      "platform": "string",
      "loginLocation": {
        "country": "string",
        "state": "string",
        "city": "string"
      }
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAuthenticationFailed	userAuthenticationFailed	-

`userThirdPartyLoginFailed`

Message is sent when user login platform failed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "platformId": "string",
      "displayName": "string"
    },
    "userAuthenticationFailed": {
      "category": "string",
      "clientName": "string",
      "country": "string",
      "detail": "string",
      "platform": "string",
      "loginLocation": {
        "country": "string",
        "state": "string",
        "city": "string"
      }
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userAccount	-
userAuthenticationFailed	userAuthenticationFailed	-

Published Messages (userInformation)

The service publishes one of these messages below.

`userInformationCreated`

Message is sent when user account is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

`userInformationDisplayNameUpdated`

Message is sent when user's display name is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

`userInformationCountryUpdated`

Message is sent when user's country is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

`userInformationLanguageUpdated`

Message is sent when user's language is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

`userInformationDateOfBirthUpdated`

Message is sent when user's birthday is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

`userInformationUsernameUpdated`

Message is sent when user's username is changed. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "userInformation": {
      "displayName": "string",
      "username": "string",
      "country": "string",
      "language": "string",
      "dateOfBirth": "string",
      "uniqueDisplayName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
userInformation	userInformation	-

Published Messages (userPermissions)

The service publishes one of these messages below.

`userPermissionCreated`

Message is sent when adding user permissions. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "permissions": [
      {
        "resoure": "string",
        "action": "string",
        "SchedAction": 0,
        "SchedCron": "string",
        "SchedRange": [
          "string"
        ]
      }
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
permissions	array of permissions	-

`userPermissionDeleted`

Message is sent when user's permission is deleted. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "permissions": [
      {
        "resoure": "string",
        "action": "string",
        "SchedAction": 0,
        "SchedCron": "string",
        "SchedRange": [
          "string"
        ]
      }
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
permissions	array of permissions	-

Published Messages (userRoles)

The service publishes one of these messages below.

`userRoleCreated`

Message is sent when role is assigned to user. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "roles": [
      {
        "roleId": "string",
        "name": "string"
      }
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
roles	`array<object>`	-

`payload.roles[number]`

Name	Type	Description
roleId	string	role id
name	string	role name

`userRoleDeleted`

Message is sent when user's role is deleted. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccount": {
      "userId": "string",
      "emailAddress": "string",
      "userName": "string",
      "country": "string",
      "namespace": "string",
      "testAccount": true,
      "gameData": [
        {
          "gameUserId": "string",
          "gameNamespace": "string"
        }
      ]
    },
    "roles": [
      "string"
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccount	userTestAccount	-
roles	array	-

Published Messages (countryAgeRestriction)

The service publishes one of these messages below.

`countryAgeRestrictionCreated`

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "countryAgeRestriction": {
      "country": "string",
      "restrictedAge": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
countryAgeRestriction	countryAgeRestriction	-

`countryAgeRestrictionUpdated`

Message is sent when country age restriction is updated. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "countryAgeRestriction": {
      "country": "string",
      "restrictedAge": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
countryAgeRestriction	countryAgeRestriction	-

Published Messages (userTranslations)

The service publishes one of these messages below.

`gameUserCreated`

Message is sent when a game account is created. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "platform": {
      "gameNamespace": "string",
      "gameUserId": "string",
      "country": "string",
      "testAccount": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
platform	object	-

`payload.platform`

Name	Type	Description
gameNamespace	string	game namespace
gameUserId	string	game user id in game namespace
country	string	country
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account

Published Messages (userFeatureBan)

The service publishes one of these messages below.

`chatAllBanned`

Message is sent when user is banned with feature restriction CHAT_ALL. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`chatSendBanned`

Message is sent when user is banned with feature restriction CHAT_SEND. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`leaderboardBanned`

Message is sent when user is banned with feature restriction LEADERBOARD. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`statisticsBanned`

Message is sent when user is banned with feature restriction STATISTICS. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`orderAndPaymentBanned`

Message is sent when user is banned with feature restriction ORDER_AND_PAYMENT. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`matchmakingBanned`

Message is sent when user is banned with feature restriction MATCHMAKING. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

`ugcCreateUpdateBanned`

Message is sent when user is banned with feature restriction UGC_CREATE_UPDATE. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userFeatureBan": {
      "userId": "string",
      "namespace": "string",
      "ban": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "reason": "string",
      "enable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userFeatureBan	userFeatureBan	-

Published Messages (lobby)

The service publishes one of these messages below.

`userDisconnectRequested`

Message is sent when user is (scheduled to be)deleted/user's permission or role is added or deleted. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userId": "string"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userId	string	-

Published Messages (deletion_account_gdpr)

The service publishes one of these messages below.

`gdprRequestDataDeletionResponse`

Message is sent after IAM receive account deletion and then delete user. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "deletionGDPR": {
      "userId": "string",
      "namespace": "string",
      "eventId": 0,
      "code": 0,
      "message": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
deletionGDPR	object	-

`payload.deletionGDPR`

Name	Type	Description
userId	string	user id
namespace	string	namespace
eventId	integer	event id
code	integer	http code
message	string	message details of the deletion result

Published Messages (oneTimeCodeLinked)

The service publishes one of these messages below.

`userAccountTransformed`

Message is sent when users choose any game account to be transformed in one time code link flow. Contains fields from event and the following payload.

Example value

{
  "payload": {
    "userAccountTransformed": {
      "initiatorGameUserId": "string",
      "initiatorNamespace": "string",
      "initiatorUserId": "string",
      "linkPlatformId": "string",
      "userId": "string",
      "chosenAccounts": [
        {
          "namespace": "string",
          "userId": "string"
        }
      ],
      "deletedAccounts": [
        {
          "namespace": "string",
          "userId": "string"
        }
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

`payload`

Name	Type	Description
userAccountTransformed	object	-

`payload.userAccountTransformed`

Name	Type	Description
initiatorGameUserId	string	the game user id who started the one time link code flow
initiatorNamespace	string	the namespace where the one time link code flow was started
initiatorUserId	string	the publisher user id who started the one time link code flow
linkPlatformId	string	the platform id of the game user account
userId	string	the target publisher user id that the game accounts are transformed to
chosenAccounts	array of namespaceUserIdPair	the game namespace and user id pairs that have been chosen to be transformed to the target publish user id
deletedAccounts	array of namespaceUserIdPair	the game namespace and user id pairs that were deleted from the target publisher user id

Schemas

loginLocation

Name	Type	Description
country	string	country
state	string	state
city	string	city

namespaceUserIdPair

Name	Type	Description
namespace	string	-
userId	string	-

userAccount

Name	Type	Description
userId	string	user id
emailAddress	string	email address
userName	string	user name
country	string	country
namespace	string	namespace
platformId	string	platform id
displayName	string	display name

userTestAccount

Name	Type	Description
userId	string	user id
emailAddress	string	email address
userName	string	user name
country	string	country
namespace	string	namespace
testAccount	boolean	a flag to indicates the user is a test account. this field will be omitted if its a real account
gameData	`array<object>`	game user ids in game namespace

gameData[number]

Name	Type	Description
gameUserId	string	game user id in game namespace
gameNamespace	string	game namespace

userAccountStatus

Name	Type	Description
deletionStatus	boolean	a flag indicates whether user is scheduled to be deleted or not
enabled	boolean	a flag indicates whether user account is enabled or not
verified	boolean	a flag indicates whether user account is verified or not

userAccountBan

Name	Type	Description
ban	`array<object>`	-

ban[number]

Name	Type	Description
banId	string	ban id
targetNamespace	string	target namespace
targetUserId	string	target user id
name	string	ban type
reason	string	reason
comment	string	comment
enabled	boolean	a flag indicates whether this user ban is enabled or not
endDate	string (date-time)	end date of this ban

userAuthentication

Name	Type	Description
platformId	string	third party platform id like ps4, ps5, live
refresh	boolean	a flag indicates this is a refresh token grant or not
platformUserId	string	third party platform account id
simultaneousPlatformId	string	third party simultaneous platform id like pspc
simultaneousPlatformUserId	string	third party simultaneous platform account id

userAuthenticationFailed

Name	Type	Description
category	string	login failed category
clientName	string	login OAuth client's name
country	string	login failed user country
detail	string	login failed error detail
platform	string	login platform, third platform(eg:steam, psn) or if it is not a headless login
loginLocation	object	-

loginLocation

Name	Type	Description
country	string	country
state	string	state
city	string	city

userInformation

Name	Type	Description
displayName	string	display name
username	string	username
country	string	country
language	string	language
dateOfBirth	string	birthday
uniqueDisplayName	string	unique display name, this will have value only when unique display name is enabled

permissions

Name	Type	Description
resoure	string	resource
action	string	action
SchedAction	integer	action, between 1 to 15
SchedCron	string	cron string or date range (both are UTC, also in cron syntax) to indicate when a permission and action are in effect
SchedRange	array	start and end date when a permission and action are in effect

countryAgeRestriction

Name	Type	Description
country	string	country name
restrictedAge	integer	age restriction

userFeatureBan

Name	Type	Description
userId	string	user id
namespace	string	target namespace
ban	string	ban type
endDate	string (date-time)	end date of this ban
reason	string	reason
enable	boolean	a flag indicates whether this ban is enabled or not

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-

On this page

Published Messages (userAccount)
Published Messages (userAuthentication)
Published Messages (userInformation)
Published Messages (userPermissions)
- userPermissionCreated
- userPermissionDeleted
Published Messages (userRoles)
- userRoleCreated
- userRoleDeleted
Published Messages (countryAgeRestriction)
- countryAgeRestrictionCreated
- countryAgeRestrictionUpdated
Published Messages (userTranslations)
- gameUserCreated
Published Messages (userFeatureBan)
Published Messages (lobby)
- userDisconnectRequested
Published Messages (deletion_account_gdpr)
- gdprRequestDataDeletionResponse
Published Messages (oneTimeCodeLinked)
- userAccountTransformed
Schemas

Published Messages (userAccount)​

userAccountCreated​

payload​

userAccountDeleted​

payload​

userAccountEnabled​

payload​

userAccountDisabled​

payload​

userAccountEmailUpdated​

payload​

userAccountPasswordUpdated​

payload​

userAccountBanned​

payload​

userAccountUnbanned​

payload​

userAccountVerified​

payload​

userAccountLinked​

payload​

payload.userAccount​

payload.userAccountThirdParty​

userAccountUnlinked​

payload​

payload.userAccount​

payload.userAccountThirdParty​

userAccountUpgraded​

payload​

payload.userAccount​

gameUserAccountCreated​

payload​

payload.userAccount​

thirdPartyAccountCreated​

payload​

payload.thirdParty​

userAccountTypeChanged​

payload​

payload.userAccount​

Published Messages (userAuthentication)​

userLoggedIn​

payload​

userLoggedOut​

payload​

userThirdPartyLoggedIn​

payload​

userLoginFailed​

payload​

userThirdPartyLoginFailed​

payload​

Published Messages (userInformation)​

userInformationCreated​

payload​

userInformationDisplayNameUpdated​

payload​

userInformationCountryUpdated​

payload​

userInformationLanguageUpdated​

payload​

userInformationDateOfBirthUpdated​

payload​

userInformationUsernameUpdated​

payload​

Published Messages (userPermissions)​

userPermissionCreated​

payload​

userPermissionDeleted​

payload​

Published Messages (userRoles)​

userRoleCreated​

payload​

payload.roles[number]​

userRoleDeleted​

payload​

Published Messages (countryAgeRestriction)​

countryAgeRestrictionCreated​

payload​

countryAgeRestrictionUpdated​

payload​

Published Messages (userTranslations)​

Published Messages (userAccount)

`userAccountCreated`

`payload`

`userAccountDeleted`

`payload`

`userAccountEnabled`

`payload`

`userAccountDisabled`

`payload`

`userAccountEmailUpdated`

`payload`

`userAccountPasswordUpdated`

`payload`

`userAccountBanned`

`payload`

`userAccountUnbanned`

`payload`

`userAccountVerified`

`payload`

`userAccountLinked`

`payload`

`payload.userAccount`

`payload.userAccountThirdParty`

`userAccountUnlinked`

`payload`

`payload.userAccount`

`payload.userAccountThirdParty`

`userAccountUpgraded`

`payload`

`payload.userAccount`

`gameUserAccountCreated`

`payload`

`payload.userAccount`

`thirdPartyAccountCreated`

`payload`

`payload.thirdParty`

`userAccountTypeChanged`

`payload`

`payload.userAccount`

Published Messages (userAuthentication)

`userLoggedIn`

`payload`

`userLoggedOut`

`payload`

`userThirdPartyLoggedIn`

`payload`

`userLoginFailed`

`payload`

`userThirdPartyLoginFailed`

`payload`

Published Messages (userInformation)

`userInformationCreated`

`payload`

`userInformationDisplayNameUpdated`

`payload`

`userInformationCountryUpdated`

`payload`

`userInformationLanguageUpdated`

`payload`

`userInformationDateOfBirthUpdated`

`payload`

`userInformationUsernameUpdated`

`payload`

Published Messages (userPermissions)

`userPermissionCreated`

`payload`

`userPermissionDeleted`

`payload`

Published Messages (userRoles)

`userRoleCreated`

`payload`

`payload.roles[number]`

`userRoleDeleted`

`payload`

Published Messages (countryAgeRestriction)

`countryAgeRestrictionCreated`

`payload`

`countryAgeRestrictionUpdated`

`payload`

Published Messages (userTranslations)