IAM Service Client Events 0.1.0 documentation

• Protobuf File Spec: iam.proto

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

Name	Type	Description
client	object	-

payload.client

Name	Type	Description
clientId	string	client id
name	string	client name
clientType	string	client type, Confidential/Public
baseUri	string	base uri of this client
redirectUri	string	redirect uri for server to redirect to after authentication
secret	string	client secret
audiences	array	target client ids who will receive token
clientPlatform	string	third party platform that will use this client, Playstation/Xbox/Steam/Epic/IOS/GooglePlay/Nintendo
twoFactorEnabled	boolean	a flag indicates whether tow factor is enabled or not
namespace	string	namespace
parentNamespace	string	studio/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

Name	Type	Description
client	client	-

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

Name	Type	Description
client	client	-

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

Name	Type	Description
client	client	-
clientThirdParty	clientThirdParty	-

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

Name	Type	Description
client	client	-
clientThirdParty	clientThirdParty	-

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

Name	Type	Description
client	client	-
clientThirdParty	clientThirdParty	-

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

Name	Type	Description
client	client	-
permissions	array<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

Name	Type	Description
client	client	-
permissions	array<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

Name	Type	Description
client	client	-
permissions	array<permissions>	-

Schemas

client

Name	Type	Description
clientId	string	client id
name	string	client name
clientType	string	client type, Confidential/Public
baseUri	string	base uri of this client
redirectUri	string	redirect uri for server to redirect to after authentication
secret	string	client secret
audiences	array	target client ids who will receive token
clientPlatform	string	third party platform that will use this client, Playstation/Xbox/Steam/Epic/IOS/GooglePlay/Nintendo
twoFactorEnabled	boolean	a flag indicates whether tow factor is enabled or not
namespace	string	namespace

permissions

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

clientThirdParty

Name	Type	Description
platformId	string	-
appId	string	-
redirectUri	string	-
secret	string	-
active	boolean	-

event

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