API Gateway Service Session Events 0.1.0 documentation
info
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://apigateway-service
- Protobuf File Spec: session.proto
Table of Contents
Operations
PUB session
Operation
Accepts one of the following messages:
Message sessionCreated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.session | object | - | - | - | additional properties are allowed |
payload.session.sessionId | string | - | - | - | - |
payload.session.userId | string | - | - | - | - |
payload.session.accessToken | string | - | - | - | - |
payload.session.refreshToken | string | - | - | - | - |
payload.session.deviceId | string | - | - | - | - |
payload.session.deviceType | string | - | - | - | - |
payload.session.deviceName | string | - | - | - | - |
payload.session.deviceOrigin | string | - | - | - | - |
payload.session.deviceOs | string | - | - | - | - |
payload.session.city | string | - | - | - | - |
payload.session.state | string | - | - | - | - |
payload.session.country | string | - | - | - | - |
payload.session.createdAt | string | - | - | format (date-time ) | - |
payload.session.expiredAt | string | - | - | format (date-time ) | - |
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": {
"session": {
"sessionId": "string",
"userId": "string",
"accessToken": "string",
"refreshToken": "string",
"deviceId": "string",
"deviceType": "string",
"deviceName": "string",
"deviceOrigin": "string",
"deviceOs": "string",
"city": "string",
"state": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"expiredAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message sessionDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.session | object | - | - | - | additional properties are allowed |
payload.session.sessionId | string | - | - | - | - |
payload.session.userId | string | - | - | - | - |
payload.session.accessToken | string | - | - | - | - |
payload.session.refreshToken | string | - | - | - | - |
payload.session.deviceId | string | - | - | - | - |
payload.session.deviceType | string | - | - | - | - |
payload.session.deviceName | string | - | - | - | - |
payload.session.deviceOrigin | string | - | - | - | - |
payload.session.deviceOs | string | - | - | - | - |
payload.session.city | string | - | - | - | - |
payload.session.state | string | - | - | - | - |
payload.session.country | string | - | - | - | - |
payload.session.createdAt | string | - | - | format (date-time ) | - |
payload.session.expiredAt | string | - | - | format (date-time ) | - |
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": {
"session": {
"sessionId": "string",
"userId": "string",
"accessToken": "string",
"refreshToken": "string",
"deviceId": "string",
"deviceType": "string",
"deviceName": "string",
"deviceOrigin": "string",
"deviceOs": "string",
"city": "string",
"state": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"expiredAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
Message sessionUpdated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | object | - | - | - | additional properties are allowed |
payload.session | object | - | - | - | additional properties are allowed |
payload.session.sessionId | string | - | - | - | - |
payload.session.userId | string | - | - | - | - |
payload.session.accessToken | string | - | - | - | - |
payload.session.refreshToken | string | - | - | - | - |
payload.session.deviceId | string | - | - | - | - |
payload.session.deviceType | string | - | - | - | - |
payload.session.deviceName | string | - | - | - | - |
payload.session.deviceOrigin | string | - | - | - | - |
payload.session.deviceOs | string | - | - | - | - |
payload.session.city | string | - | - | - | - |
payload.session.state | string | - | - | - | - |
payload.session.country | string | - | - | - | - |
payload.session.createdAt | string | - | - | format (date-time ) | - |
payload.session.expiredAt | string | - | - | format (date-time ) | - |
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": {
"session": {
"sessionId": "string",
"userId": "string",
"accessToken": "string",
"refreshToken": "string",
"deviceId": "string",
"deviceType": "string",
"deviceName": "string",
"deviceOrigin": "string",
"deviceOs": "string",
"city": "string",
"state": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"expiredAt": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}