Skip to main content

IAM Service Account Events 0.1.0 documentation

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

NameTypeDescription
userAccountuserTestAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserTestAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserTestAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserTestAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountuserTestAccount-
userAccountBanuserAccountBan-

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

NameTypeDescription
userAccountuserTestAccount-
userAccountBanuserAccountBan-

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

NameTypeDescription
userAccountuserAccount-
userAccountStatususerAccountStatus-
namespacestringnamespace
userIdstringuser 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

NameTypeDescription
userAccountobject-
userAccountThirdPartyobject-
payload.userAccount
NameTypeDescription
namespacestringtarget namespace
userIdstringuser id
emailAddressstringemail address
testAccountbooleana flag to indicates the user is a test account. this field will be omitted if its a real account
publisherNamespacestringpublisher namespace
publisherUserIdstringpublisher user id
payload.userAccountThirdParty
NameTypeDescription
platformIdstringthird party platform id
platformUserIdstringthird party platform user id
platformDisplayNamestringthird 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

NameTypeDescription
userAccountobject-
userAccountThirdPartyobject-
payload.userAccount
NameTypeDescription
userIdstringpublisher user id
emailAddressstringemail address
targetNamespacestringtarget namespace
targetUserIdstringtarget user id in target namespace
testAccountbooleana flag to indicates the user is a test account. this field will be omitted if its a real account
namespacestringpublisher namespace
linkedAccountsarray<userAccount>game accounts in the game namespaces where the account link happened
payload.userAccountThirdParty
NameTypeDescription
platformIdstringthird party platform id
platformUserIdstringthird party platform user id
platformstringthird 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

NameTypeDescription
userAccountobject-
payload.userAccount
NameTypeDescription
userIdstringuser id
emailAddressstringuser email address
publisherUserIdstringpublisher user id
namespacestringnamespace
testAccountbooleana 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

NameTypeDescription
userAccountobject-
userAccountStatususerAccountStatus-
namespacestring-
userIdstring-
payload.userAccount
NameTypeDescription
userIdstringgame user id in game namespace
emailAddressstringemail address
gameNamespacestringgame namespace
countrystringuser country
testAccountbooleana 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

NameTypeDescription
thirdPartyobject-
namespacestringpublisher namespace
userIdstringpublisher user id
payload.thirdParty
NameTypeDescription
userIdstringpublisher user id
thirdPartyUserIdstringthird party platform user id
platformIdstringthird party platform id
namespacestringnamespace
displayNamestringsynced from third party, gamer tag for xbox/online id for psn, etc
countrystringcountry
emailAddressstringthird 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

NameTypeDescription
userAccountobject-
payload.userAccount
NameTypeDescription
userIdstringuser id
namespacestringnamespace
testAccountbooleana 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. 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

NameTypeDescription
userAccountuserAccount-
userAuthenticationuserAuthentication-

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

NameTypeDescription
userAccountuserAccount-
userAuthenticationuserAuthentication-

userThirdPartyLoggedIn

Message is sent when user login with a third party account. 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

NameTypeDescription
userAccountuserAccount-
userAuthenticationuserAuthentication-

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"
}
},
"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

NameTypeDescription
userAccountuserAccount-
userAuthenticationFaileduserAuthenticationFailed-

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"
}
},
"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

NameTypeDescription
userAccountuserAccount-
userAuthenticationFaileduserAuthenticationFailed-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
userInformationuserInformation-

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

NameTypeDescription
userAccountuserTestAccount-
permissionsarray<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

NameTypeDescription
userAccountuserTestAccount-
permissionsarray<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

NameTypeDescription
userAccountuserTestAccount-
rolesarray<object>-
payload.roles[number]
NameTypeDescription
roleIdstringrole id
namestringrole 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

NameTypeDescription
userAccountuserTestAccount-
rolesarray-

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

NameTypeDescription
countryAgeRestrictioncountryAgeRestriction-

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

NameTypeDescription
countryAgeRestrictioncountryAgeRestriction-

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

NameTypeDescription
platformobject-
payload.platform
NameTypeDescription
gameNamespacestringgame namespace
gameUserIdstringgame user id in game namespace
countrystringcountry
testAccountbooleana 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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userFeatureBanuserFeatureBan-

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

NameTypeDescription
userIdstring-

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

NameTypeDescription
deletionGDPRobject-
payload.deletionGDPR
NameTypeDescription
userIdstringuser id
namespacestringnamespace
eventIdintegerevent id
codeintegerhttp code
messagestringmessage details of the deletion result

Schemas

userAccount

NameTypeDescription
userIdstringuser id
emailAddressstringemail address
userNamestringuser name
countrystringcountry
namespacestringnamespace
platformIdstringplatform id
displayNamestringdisplay name

userTestAccount

NameTypeDescription
userIdstringuser id
emailAddressstringemail address
userNamestringuser name
countrystringcountry
namespacestringnamespace
testAccountbooleana flag to indicates the user is a test account. this field will be omitted if its a real account
gameDataarray<object>game user ids in game namespace

gameData[number]

NameTypeDescription
gameUserIdstringgame user id in game namespace
gameNamespacestringgame namespace

userAccountStatus

NameTypeDescription
deletionStatusbooleana flag indicates whether user is scheduled to be deleted or not
enabledbooleana flag indicates whether user account is enabled or not
verifiedbooleana flag indicates whether user account is verified or not

userAccountBan

NameTypeDescription
banarray<object>-

ban[number]

NameTypeDescription
banIdstringban id
targetNamespacestringtarget namespace
targetUserIdstringtarget user id
namestringban type
reasonstringreason
commentstringcomment
enabledbooleana flag indicates whether this user ban is enabled or not
endDatestring (date-time)end date of this ban

userAuthentication

NameTypeDescription
platformIdstringthird party platform id like ps4, ps5, live
refreshbooleana flag indicates this is a refresh token grant or not
platformUserIdstringthird party platform account id
simultaneousPlatformIdstringthird party simultaneous platform id like pspc
simultaneousPlatformUserIdstringthird party simultaneous platform account id

userAuthenticationFailed

NameTypeDescription
categorystringlogin failed category
clientNamestringlogin OAuth client's name
countrystringlogin failed user country
detailstringlogin failed error detail
platformstringlogin platform, third platform(eg:steam, psn) or if it is not a headless login

userInformation

NameTypeDescription
displayNamestringdisplay name
usernamestringusername
countrystringcountry
languagestringlanguage
dateOfBirthstringbirthday
uniqueDisplayNamestringunique display name, this will have value only when unique display name is enabled

permissions

NameTypeDescription
resourestringresource
actionstringaction
SchedActionintegeraction, between 1 to 15
SchedCronstringcron string or date range (both are UTC, also in cron syntax) to indicate when a permission and action are in effect
SchedRangearraystart and end date when a permission and action are in effect

countryAgeRestriction

NameTypeDescription
countrystringcountry name
restrictedAgeintegerage restriction

userFeatureBan

NameTypeDescription
userIdstringuser id
namespacestringtarget namespace
banstringban type
endDatestring (date-time)end date of this ban
reasonstringreason
enablebooleana flag indicates whether this ban is enabled or not

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstring-
traceIdstring-
sessionIdstring-