IAM Service OAuth Events 0.1.0 documentation
- Protobuf File Spec: iam.proto
Published Messages (oauthRequest)
The service publishes one of these messages below.
oauthRequestAuthorized
Message is sent when user initializes OAuth 2.0 authorization code flow. Contains fields from event and the following payload.
Example value
{
"payload": {
"oauth": {
"clientId": "string",
"responseType": "string",
"platformId": "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 |
|---|---|---|
| oauth | oauth | - |
Published Messages (oauthToken)
The service publishes one of these messages below.
oauthTokenGenerated
Message is sent after user successfully login/refresh token(not login by third party). Contains fields from event and the following payload.
Example value
{
"payload": {
"oauth": {
"clientId": "string",
"responseType": "string",
"platformId": "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 |
|---|---|---|
| oauth | oauth | - |
oauthTokenRevoked
Message is sent after user is revoked or token is revoked. Contains fields from event and the following payload.
Example value
{
"payload": {
"oauth": {
"clientId": "string",
"responseType": "string",
"platformId": "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 |
|---|---|---|
| oauth | oauth | - |
Published Messages (oauthThirdPartyRequest)
The service publishes one of these messages below.
oauthThirdPartyRequestAuthorized
Message is sent after user initializes third party authorization. Contains fields from event and the following payload.
Example value
{
"payload": {
"oauth": {
"clientId": "string",
"responseType": "string",
"platformId": "string"
},
"oauthThirdParty": {
"platformId": "string",
"displayName": "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 |
|---|---|---|
| oauth | oauth | - |
| oauthThirdParty | oauthThirdParty | - |
Published Messages (oauthThirdPartyToken)
The service publishes one of these messages below.
oauthThirdPartyTokenGenerated
Message is sent after user successfully login with third party account. Contains fields from event and the following payload.
Example value
{
"payload": {
"oauth": {
"clientId": "string",
"responseType": "string",
"platformId": "string"
},
"oauthThirdParty": {
"platformId": "string",
"displayName": "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 |
|---|---|---|
| oauth | oauth | - |
| oauthThirdParty | oauthThirdParty | - |
Schemas
oauth
| Name | Type | Description |
|---|---|---|
| clientId | string | oauth client id |
| responseType | string | response type, code/token |
| platformId | string | third party platform id |
oauthThirdParty
| Name | Type | Description |
|---|---|---|
| platformId | string | third party platform id |
| displayName | string | display name |
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 | - |