IAM Service Account Events 0.1.0 documentation
In this document, PUB
means "publish" and SUB
means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.
- Specification ID:
http://iam-service
- Protobuf File Spec: account.proto
Table of Contents
Operations
PUB userAccount
Operation
Accepts one of the following messages:
Message userAccountCreated
message is sent when publisher user account is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountDeleted
message is sent when user account is deleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountEnabled
message is sent when user account is enabled
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountDisabled
message is sent when user account is disabled
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountEmailUpdated
message is sent when user change own email/admin change user's email, email is not verified yet
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountPasswordUpdated
message is sent when user update password
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountBanned
message is sent when user is banned
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountBan | object | - | - | - | additional properties are allowed |
payload.userAccountBan.ban | array<object> | - | - | - | - |
payload.userAccountBan.ban.banId | string | ban id | - | - | - |
payload.userAccountBan.ban.targetNamespace | string | target namespace | - | - | - |
payload.userAccountBan.ban.targetUserId | string | target user id | - | - | - |
payload.userAccountBan.ban.name | string | ban type | - | - | - |
payload.userAccountBan.ban.reason | string | reason | - | - | - |
payload.userAccountBan.ban.comment | string | comment | - | - | - |
payload.userAccountBan.ban.enabled | boolean | a flag indicates whether this user ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message userAccountUnbanned
message is sent when user is unbanned
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userAccountBan | object | - | - | - | additional properties are allowed |
payload.userAccountBan.ban | array<object> | - | - | - | - |
payload.userAccountBan.ban.banId | string | ban id | - | - | - |
payload.userAccountBan.ban.targetNamespace | string | target namespace | - | - | - |
payload.userAccountBan.ban.targetUserId | string | target user id | - | - | - |
payload.userAccountBan.ban.name | string | ban type | - | - | - |
payload.userAccountBan.ban.reason | string | reason | - | - | - |
payload.userAccountBan.ban.comment | string | comment | - | - | - |
payload.userAccountBan.ban.enabled | boolean | a flag indicates whether this user ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message userAccountVerified
message is sent when user account is verified
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | namespace | - | - | - |
payload.userId | string | user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountLinked
message is sent when user account is linked to a third party platform
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.namespace | string | target namespace | - | - | - |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.publisherNamespace | string | publisher namespace | - | - | - |
payload.userAccount.publisherUserId | string | publisher user id | - | - | - |
payload.userAccountThirdParty | object | - | - | - | additional properties are allowed |
payload.userAccountThirdParty.platformId | string | third party platform id | - | - | - |
payload.userAccountThirdParty.platformUserId | string | third party platform user id | - | - | - |
payload.userAccountThirdParty.platformDisplayName | string | third party platform user display name | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountUnlinked
message is sent when user account and third party platform are unlinked
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | publisher user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.targetNamespace | string | target namespace | - | - | - |
payload.userAccount.targetUserId | string | target user id in target namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.namespace | string | publisher namespace | - | - | - |
payload.userAccount.linkedAccounts | array<object> | game accounts in the game namespaces where the account link happened | - | - | - |
payload.userAccount.linkedAccounts.userId | string | user id | - | - | - |
payload.userAccount.linkedAccounts.emailAddress | string | email address | - | - | - |
payload.userAccount.linkedAccounts.userName | string | user name | - | - | - |
payload.userAccount.linkedAccounts.country | string | country | - | - | - |
payload.userAccount.linkedAccounts.namespace | string | namespace | - | - | - |
payload.userAccount.linkedAccounts.platformId | string | platform id | - | - | - |
payload.userAccount.linkedAccounts.displayName | string | display name | - | - | - |
payload.userAccountThirdParty | object | - | - | - | additional properties are allowed |
payload.userAccountThirdParty.platformId | string | third party platform id | - | - | - |
payload.userAccountThirdParty.platformUserId | string | third party platform user id | - | - | - |
payload.userAccountThirdParty.platform | string | third party platform, it can be the platform id or the account group name | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountUpgraded
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | user email address | - | - | - |
payload.userAccount.publisherUserId | string | publisher user id | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message gameUserAccountCreated
message is sent when user account in game namespace is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | game user id in game namespace | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.gameNamespace | string | game namespace | - | - | - |
payload.userAccount.country | string | user country | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccountStatus | object | - | - | - | additional properties are allowed |
payload.userAccountStatus.deletionStatus | boolean | a flag indicates whether user is scheduled to be deleted or not | - | - | - |
payload.userAccountStatus.enabled | boolean | a flag indicates whether user account is enabled or not | - | - | - |
payload.userAccountStatus.verified | boolean | a flag indicates whether user account is verified or not | - | - | - |
payload.namespace | string | - | - | - | - |
payload.userId | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message thirdPartyAccountCreated
message is sent when a third party is linked to an account or first login
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.thirdParty | object | - | - | - | additional properties are allowed |
payload.thirdParty.userId | string | publisher user id | - | - | - |
payload.thirdParty.thirdPartyUserId | string | third party platform user id | - | - | - |
payload.thirdParty.platformId | string | third party platform id | - | - | - |
payload.thirdParty.namespace | string | namespace | - | - | - |
payload.thirdParty.displayName | string | synced from third party, gamer tag for xbox/online id for psn, etc | - | - | - |
payload.thirdParty.country | string | country | - | - | - |
payload.thirdParty.emailAddress | string | third party platform email address | - | - | - |
payload.namespace | string | publisher namespace | - | - | - |
payload.userId | string | publisher user id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userAccountTypeChanged
message is sent when user's account type is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userAuthentication
Operation
Accepts one of the following messages:
Message userLoggedIn
message is sent when user login
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAuthentication | object | - | - | - | additional properties are allowed |
payload.userAuthentication.platformId | string | third party platform id like ps4, ps5, live | - | - | - |
payload.userAuthentication.refresh | boolean | a flag indicates this is a refresh token grant or not | - | - | - |
payload.userAuthentication.platformUserId | string | third party platform account id | - | - | - |
payload.userAuthentication.simultaneousPlatformId | string | third party simultaneous platform id like pspc | - | - | - |
payload.userAuthentication.simultaneousPlatformUserId | string | third party simultaneous platform account id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userLoggedOut
message is sent when user logout
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAuthentication | object | - | - | - | additional properties are allowed |
payload.userAuthentication.platformId | string | third party platform id like ps4, ps5, live | - | - | - |
payload.userAuthentication.refresh | boolean | a flag indicates this is a refresh token grant or not | - | - | - |
payload.userAuthentication.platformUserId | string | third party platform account id | - | - | - |
payload.userAuthentication.simultaneousPlatformId | string | third party simultaneous platform id like pspc | - | - | - |
payload.userAuthentication.simultaneousPlatformUserId | string | third party simultaneous platform account id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userThirdPartyLoggedIn
message is sent when user login with a third party account
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAuthentication | object | - | - | - | additional properties are allowed |
payload.userAuthentication.platformId | string | third party platform id like ps4, ps5, live | - | - | - |
payload.userAuthentication.refresh | boolean | a flag indicates this is a refresh token grant or not | - | - | - |
payload.userAuthentication.platformUserId | string | third party platform account id | - | - | - |
payload.userAuthentication.simultaneousPlatformId | string | third party simultaneous platform id like pspc | - | - | - |
payload.userAuthentication.simultaneousPlatformUserId | string | third party simultaneous platform account id | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userLoginFailed
message is sent when user login failed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAuthenticationFailed | object | - | - | - | additional properties are allowed |
payload.userAuthenticationFailed.category | string | login failed category | - | - | - |
payload.userAuthenticationFailed.clientName | string | login OAuth client's name | - | - | - |
payload.userAuthenticationFailed.country | string | login failed user country | - | - | - |
payload.userAuthenticationFailed.detail | string | login failed error detail | - | - | - |
payload.userAuthenticationFailed.platform | string | login platform, third platform(eg:steam, psn) or if it is not a headless login | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userThirdPartyLoginFailed
message is sent when user login platform failed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.platformId | string | platform id | - | - | - |
payload.userAccount.displayName | string | display name | - | - | - |
payload.userAuthenticationFailed | object | - | - | - | additional properties are allowed |
payload.userAuthenticationFailed.category | string | login failed category | - | - | - |
payload.userAuthenticationFailed.clientName | string | login OAuth client's name | - | - | - |
payload.userAuthenticationFailed.country | string | login failed user country | - | - | - |
payload.userAuthenticationFailed.detail | string | login failed error detail | - | - | - |
payload.userAuthenticationFailed.platform | string | login platform, third platform(eg:steam, psn) or if it is not a headless login | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userInformation
Operation
Accepts one of the following messages:
Message userInformationCreated
message is sent when user account is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userInformationDisplayNameUpdated
message is sent when user's display name is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userInformationCountryUpdated
message is sent when user's country is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userInformationLanguageUpdated
message is sent when user's language is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userInformationDateOfBirthUpdated
message is sent when user's birthday is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userInformationUsernameUpdated
message is sent when user's username is changed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.userInformation | object | - | - | - | additional properties are allowed |
payload.userInformation.displayName | string | display name | - | - | - |
payload.userInformation.username | string | username | - | - | - |
payload.userInformation.country | string | country | - | - | - |
payload.userInformation.language | string | language | - | - | - |
payload.userInformation.dateOfBirth | string | birthday | - | - | - |
payload.userInformation.uniqueDisplayName | string | unique display name, this will have value only when unique display name is enabled | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userPermissions
Operation
Accepts one of the following messages:
Message userPermissionCreated
message is sent when adding user permissions
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.permissions | array<object> | - | - | - | - |
payload.permissions.resoure | string | resource | - | - | - |
payload.permissions.action | string | action | - | - | - |
payload.permissions.SchedAction | integer | action, between 1 to 15 | - | - | deprecated |
payload.permissions.SchedCron | string | cron string or date range (both are UTC, also in cron syntax) to indicate when a permission and action are in effect | - | - | deprecated |
payload.permissions.SchedRange | array<string> | start and end date when a permission and action are in effect | - | - | deprecated |
payload.permissions.SchedRange (single item) | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userPermissionDeleted
message is sent when user's permission is deleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.permissions | array<object> | - | - | - | - |
payload.permissions.resoure | string | resource | - | - | - |
payload.permissions.action | string | action | - | - | - |
payload.permissions.SchedAction | integer | action, between 1 to 15 | - | - | deprecated |
payload.permissions.SchedCron | string | cron string or date range (both are UTC, also in cron syntax) to indicate when a permission and action are in effect | - | - | deprecated |
payload.permissions.SchedRange | array<string> | start and end date when a permission and action are in effect | - | - | deprecated |
payload.permissions.SchedRange (single item) | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userRoles
Operation
Accepts one of the following messages:
Message userRoleCreated
message is sent when role is assigned to user
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.roles | array<object> | - | - | - | - |
payload.roles.roleId | string | role id | - | - | - |
payload.roles.name | string | role name | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message userRoleDeleted
message is sent when user's role is deleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userAccount | object | - | - | - | additional properties are allowed |
payload.userAccount.userId | string | user id | - | - | - |
payload.userAccount.emailAddress | string | email address | - | - | - |
payload.userAccount.userName | string | user name | - | - | - |
payload.userAccount.country | string | country | - | - | - |
payload.userAccount.namespace | string | namespace | - | - | - |
payload.userAccount.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
payload.userAccount.gameData | array<object> | game user ids in game namespace | - | - | - |
payload.userAccount.gameData.gameUserId | string | game user id in game namespace | - | - | - |
payload.userAccount.gameData.gameNamespace | string | game namespace | - | - | - |
payload.roles | array<any> | - | - | - | - |
payload.roles (single item) | any | - | - | - | additional properties are allowed |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userAccount": {
"userId": "string",
"emailAddress": "string",
"userName": "string",
"country": "string",
"namespace": "string",
"testAccount": true,
"gameData": [
{
"gameUserId": "string",
"gameNamespace": "string"
}
]
},
"roles": [
null
]
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
PUB countryAgeRestriction
Operation
Accepts one of the following messages:
Message countryAgeRestrictionCreated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.countryAgeRestriction | object | - | - | - | additional properties are allowed |
payload.countryAgeRestriction.country | string | country name | - | - | - |
payload.countryAgeRestriction.restrictedAge | integer | age restriction | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message countryAgeRestrictionUpdated
message is sent when country age restriction is updated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.countryAgeRestriction | object | - | - | - | additional properties are allowed |
payload.countryAgeRestriction.country | string | country name | - | - | - |
payload.countryAgeRestriction.restrictedAge | integer | age restriction | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userTranslations
Operation
Message gameUserCreated
message is sent when a game account is created
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.platform | object | - | - | - | additional properties are allowed |
payload.platform.gameNamespace | string | game namespace | - | - | - |
payload.platform.gameUserId | string | game user id in game namespace | - | - | - |
payload.platform.country | string | country | - | - | - |
payload.platform.testAccount | boolean | a flag to indicates the user is a test account. this field will be omitted if its a real account | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB userFeatureBan
Operation
Accepts one of the following messages:
Message chatAllBanned
message is sent when user is banned with feature restriction CHAT_ALL
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message chatSendBanned
message is sent when user is banned with feature restriction CHAT_SEND
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message leaderboardBanned
message is sent when user is banned with feature restriction LEADERBOARD
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message statisticsBanned
message is sent when user is banned with feature restriction STATISTICS
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message orderAndPaymentBanned
message is sent when user is banned with feature restriction ORDER_AND_PAYMENT
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message matchmakingBanned
message is sent when user is banned with feature restriction MATCHMAKING
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message ugcCreateUpdateBanned
message is sent when user is banned with feature restriction UGC_CREATE_UPDATE
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userFeatureBan | object | - | - | - | additional properties are allowed |
payload.userFeatureBan.userId | string | user id | - | - | - |
payload.userFeatureBan.namespace | string | target namespace | - | - | - |
payload.userFeatureBan.ban | string | ban type | - | - | - |
payload.userFeatureBan.endDate | string | end date of this ban | - | format (date-time ) | - |
payload.userFeatureBan.reason | string | reason | - | - | - |
payload.userFeatureBan.enable | boolean | a flag indicates whether this ban is enabled or not | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB lobby
Operation
Message userDisconnectRequested
message is sent when user is (scheduled to be)deleted/user's permission or role is added or deleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.userId | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB deletion_account_gdpr
Operation
Message gdprRequestDataDeletionResponse
message is sent after IAM receive account deletion and then delete user
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.deletionGDPR | object | - | - | - | additional properties are allowed |
payload.deletionGDPR.userId | string | user id | - | - | - |
payload.deletionGDPR.namespace | string | namespace | - | - | - |
payload.deletionGDPR.eventId | integer | event id | - | - | - |
payload.deletionGDPR.code | integer | http code | - | - | - |
payload.deletionGDPR.message | string | message details of the deletion result | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | - | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}