GDPR Service Events 0.1.0 documentation
- Specification ID:
http://gdpr-service
Table of Contents
- Operations
- PUB deletion_account_gdpr
- PUB dev_eventstream_gdpr_activity
- PUB dev_eventstream_gdpr_data_request_canceled
- PUB dev_eventstream_gdpr_data_request_downloaded
- PUB dev_eventstream_gdpr_data_retrieval_requested
- PUB dev_eventstream_email_configuration_modified
- PUB dev_eventstream_gdpr_data_deletion_requested
- PUB dev_eventstream_gdpr_data_deletion_cancelled
- PUB stage_eventstream_gdpr_activity
- PUB stage_eventstream_gdpr_data_request_canceled
- PUB stage_eventstream_gdpr_data_request_downloaded
- PUB stage_eventstream_gdpr_data_retrieval_requested
- PUB stage_eventstream_email_configuration_modified
- PUB stage_eventstream_gdpr_data_deletion_requested
- PUB stage_eventstream_gdpr_data_deletion_cancelled
- PUB prod_eventstream_gdpr_activity
- PUB prod_eventstream_gdpr_data_request_canceled
- PUB prod_eventstream_gdpr_data_request_downloaded
- PUB prod_eventstream_gdpr_data_retrieval_requested
- PUB prod_eventstream_email_configuration_modified
- PUB prod_eventstream_gdpr_data_deletion_requested
- PUB prod_eventstream_gdpr_data_deletion_cancelled
Operations
PUB deletion_account_gdpr
Operation
Accepts one of the following messages:
Message gdprRequestDataDeletion
message is sent when account deletion request is processed
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | 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)
{
"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 gdprRequestDataDeletionResponse
get the response from IAM of the account deletion result
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.code | integer | http code | - | - | - |
payload.deletionGDPR.message | string | result message | - | - | - |
payload.deletionGDPR.userId | string | user id | - | - | - |
payload.deletionGDPR.namespace | string | namespace | - | - | - |
payload.deletionGDPR.eventId | integer | event 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": {
"deletionGDPR": {
"code": 0,
"message": "string",
"userId": "string",
"namespace": "string",
"eventId": 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 dev_eventstream_gdpr_activity
Operation
Accepts one of the following messages:
Message gdprAdminGetListPersonalDataRequested
message is sent when admin query the list of user personal requests
Message gdprGetUserPersonalDataRequested
message is sent when admin/user request user/own personal data
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"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 dev_eventstream_gdpr_data_request_canceled
Operation
Message gdprCancelUserPersonalDataRequested
message is sent when admin/user cancel the personal data request
PUB dev_eventstream_gdpr_data_request_downloaded
Operation
Message gdprGeneratePersonalDataURLRequested
message is sent when admin/user request signed storage url
PUB dev_eventstream_gdpr_data_retrieval_requested
Operation
Accepts one of the following messages:
Message gdprPublicRequestDataRetrievalRequested
message is sent when user requests personal data
Message gdprAdminRequestDataRetrievalRequested
message is sent when admin requests user personal data
PUB dev_eventstream_email_configuration_modified
Operation
Accepts one of the following messages:
Message gdprSaveAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is changed
Message gdprGetAdminEmailAddressConfigurationsRequested
message is sent when admin query email recipients configuration
Message gdprUpdateAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is updated
Message gdprDeleteAdminEmailAddressConfigurationsRequested
message is sent when admin delete email addresses from the email recipients configuration
PUB dev_eventstream_gdpr_data_deletion_requested
Operation
Accepts one of the following messages:
Message gdprUserDeletionRequested
message is sent when admin/user request user/own account deletion
Message gdprAdminGetListDeletionDataRequested
message is sent when admin query the list of account deletion requests
Message gdprGetSpecificUserDeletionRequested
message is sent when admin get a user's account deletion request
Message gdprGetSpecificUserDeletionStatusRequested
message is sent when getting user's account deletion status
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"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 dev_eventstream_gdpr_data_deletion_cancelled
Operation
Message gdprCancelUserDeletionRequested
PUB stage_eventstream_gdpr_activity
Operation
Accepts one of the following messages:
Message gdprAdminGetListPersonalDataRequested
message is sent when admin query the list of user personal requests
Message gdprGetUserPersonalDataRequested
message is sent when admin/user request user/own personal data
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"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 stage_eventstream_gdpr_data_request_canceled
Operation
Message gdprCancelUserPersonalDataRequested
message is sent when admin/user cancel the personal data request
PUB stage_eventstream_gdpr_data_request_downloaded
Operation
Message gdprGeneratePersonalDataURLRequested
message is sent when admin/user request signed storage url
PUB stage_eventstream_gdpr_data_retrieval_requested
Operation
Accepts one of the following messages:
Message gdprPublicRequestDataRetrievalRequested
message is sent when user requests personal data
Message gdprAdminRequestDataRetrievalRequested
message is sent when admin requests user personal data
PUB stage_eventstream_email_configuration_modified
Operation
Accepts one of the following messages:
Message gdprSaveAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is changed
Message gdprGetAdminEmailAddressConfigurationsRequested
message is sent when admin query email recipients configuration
Message gdprUpdateAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is updated
Message gdprDeleteAdminEmailAddressConfigurationsRequested
message is sent when admin delete email addresses from the email recipients configuration
PUB stage_eventstream_gdpr_data_deletion_requested
Operation
Accepts one of the following messages:
Message gdprUserDeletionRequested
message is sent when admin/user request user/own account deletion
Message gdprAdminGetListDeletionDataRequested
message is sent when admin query the list of account deletion requests
Message gdprGetSpecificUserDeletionRequested
message is sent when admin get a user's account deletion request
Message gdprGetSpecificUserDeletionStatusRequested
message is sent when getting user's account deletion status
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"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 stage_eventstream_gdpr_data_deletion_cancelled
Operation
Message gdprCancelUserDeletionRequested
PUB prod_eventstream_gdpr_activity
Operation
Accepts one of the following messages:
Message gdprAdminGetListPersonalDataRequested
message is sent when admin query the list of user personal requests
Message gdprGetUserPersonalDataRequested
message is sent when admin/user request user/own personal data
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"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 prod_eventstream_gdpr_data_request_canceled
Operation
Message gdprCancelUserPersonalDataRequested
message is sent when admin/user cancel the personal data request
PUB prod_eventstream_gdpr_data_request_downloaded
Operation
Message gdprGeneratePersonalDataURLRequested
message is sent when admin/user request signed storage url
PUB prod_eventstream_gdpr_data_retrieval_requested
Operation
Accepts one of the following messages:
Message gdprPublicRequestDataRetrievalRequested
message is sent when user requests personal data
Message gdprAdminRequestDataRetrievalRequested
message is sent when admin requests user personal data
PUB prod_eventstream_email_configuration_modified
Operation
Accepts one of the following messages:
Message gdprSaveAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is changed
Message gdprGetAdminEmailAddressConfigurationsRequested
message is sent when admin query email recipients configuration
Message gdprUpdateAdminEmailAddressConfigurationsRequested
message is sent when admin email recipients configuration is updated
Message gdprDeleteAdminEmailAddressConfigurationsRequested
message is sent when admin delete email addresses from the email recipients configuration
PUB prod_eventstream_gdpr_data_deletion_requested
Operation
Accepts one of the following messages:
Message gdprUserDeletionRequested
message is sent when admin/user request user/own account deletion
Message gdprAdminGetListDeletionDataRequested
message is sent when admin query the list of account deletion requests
Message gdprGetSpecificUserDeletionRequested
message is sent when admin get a user's account deletion request
Message gdprGetSpecificUserDeletionStatusRequested
message is sent when getting user's account deletion status
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | object allOf | - | - | - | additional properties are allowed |
payload | array<any> | - | - | - | - |
payload.requestPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData | object | - | - | - | additional properties are allowed |
payload.requestPersonalData.userPersonalData.status | string | status of the personal data request, one of Pending/In-Progress/Completed/Canceled/Failed/Expired | - | - | - |
payload.requestPersonalData.userPersonalData.requestDate | string | time when the personal data request is made | - | format (date-time ) | - |
payload.requestPersonalData.userPersonalData.dataExpirationDate | string | time when the personal data will expire in S3 | - | 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": [],
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}