Skip to main content

IAM Service Client Events 0.1.0 documentation

Published Messages (client)

The service publishes one of these messages below.

clientCreated

Message is sent when an IAM oauth client is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string",
"parentNamespace": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientobject-
payload.client
NameTypeDescription
clientIdstringclient id
namestringclient name
clientTypestringclient type, Confidential/Public
baseUristringbase uri of this client
redirectUristringredirect uri for server to redirect to after authentication
secretstringclient secret
audiencesarraytarget client ids who will receive token
clientPlatformstringthird party platform that will use this client, Playstation/Xbox/Steam/Epic/IOS/GooglePlay/Nintendo
twoFactorEnabledbooleana flag indicates whether tow factor is enabled or not
namespacestringnamespace
parentNamespacestringstudio/publisher namespace in multi tenant mode

clientDeleted

Message is sent when IAM oauth client is deleted. Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-

clientUpdated

Message is sent when IAM oauth client is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-

Published Messages (clientThirdParty)

The service publishes one of these messages below.

clientThirdPartyCreated

Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"clientThirdParty": {
"platformId": "string",
"appId": "string",
"redirectUri": "string",
"secret": "string",
"active": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
clientThirdPartyclientThirdParty-

clientThirdPartyDeleted

Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"clientThirdParty": {
"platformId": "string",
"appId": "string",
"redirectUri": "string",
"secret": "string",
"active": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
clientThirdPartyclientThirdParty-

clientThirdPartyUpdated

Deprecated. Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"clientThirdParty": {
"platformId": "string",
"appId": "string",
"redirectUri": "string",
"secret": "string",
"active": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
clientThirdPartyclientThirdParty-

Published Messages (clientPermissions)

The service publishes one of these messages below.

clientPermissionCreated

Message is sent when adding permission to oauth client. Contains fields from event and the following payload.

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"permissions": [
{
"resoure": "string",
"action": "string",
"SchedAction": 0,
"SchedCron": "string",
"SchedRange": [
"string"
]
}
]
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
permissionsarray<permissions>-

clientPermissionDeleted

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

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"permissions": [
{
"resoure": "string",
"action": "string",
"SchedAction": 0,
"SchedCron": "string",
"SchedRange": [
"string"
]
}
]
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
permissionsarray<permissions>-

clientPermissionUpdated

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

Example value
{
"payload": {
"client": {
"clientId": "string",
"name": "string",
"clientType": "string",
"baseUri": "string",
"redirectUri": "string",
"secret": "string",
"audiences": [
"string"
],
"clientPlatform": "string",
"twoFactorEnabled": true,
"namespace": "string"
},
"permissions": [
{
"resoure": "string",
"action": "string",
"SchedAction": 0,
"SchedCron": "string",
"SchedRange": [
"string"
]
}
]
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
clientclient-
permissionsarray<permissions>-

Schemas

client

NameTypeDescription
clientIdstringclient id
namestringclient name
clientTypestringclient type, Confidential/Public
baseUristringbase uri of this client
redirectUristringredirect uri for server to redirect to after authentication
secretstringclient secret
audiencesarraytarget client ids who will receive token
clientPlatformstringthird party platform that will use this client, Playstation/Xbox/Steam/Epic/IOS/GooglePlay/Nintendo
twoFactorEnabledbooleana flag indicates whether tow factor is enabled or not
namespacestringnamespace

permissions

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

clientThirdParty

NameTypeDescription
platformIdstring-
appIdstring-
redirectUristring-
secretstring-
activeboolean-

event

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