ForgetMe gRPC API
The ForgetMe gRPC API contains an RPC method for requesting the removal of data in event logs.
Tip:
Try out this API using a Sample ForgetMe client that you can download and run on Linux or Windows.Proto file structure
The ForgetMe API is defined in the forget.proto file and RPC files containing status and error messages. See gRPC setup to download the files.
└── nuance
├── fabric
│ └── forget
│ └── v1
│ └── forget.proto
└── rpc
├── error_details.proto
├── status_code.proto
└── status.proto
ForgetMe
The ForgetMe service offers one RPC method for requesting data removal.
Method | Request and response | Description |
---|---|---|
Forget | Starts a forget request and returns a response (unary). |
ForgetRequest
Input message that requests the removal of event logs based on a user ID or session ID.
Field | Type | Description |
---|---|---|
forget_id | string | Mandatory. A user or session ID from a Mix runtime request. See ForgetMe essentials. |
forget_type | ForgetType | The type of forget_id: USER (default) or SESSION. |
client_data | map<string,string> | Optional. Client-supplied key,value pairs (up to 20) to inject into the logs. |
ForgetRequest (
forget_id = 'eric@aardvark.com`,
forget_type = USER
client_data = {'app_os':'Centos','company':'Aardvark'},
)
ForgetType
Input field specifying whether forget_id
represents a user or session ID in a request to a Mix runtime service.
Name | Number | Description |
---|---|---|
USER | 0 | A user ID from a request to a Mix service. Default. |
SESSION | 1 | A session ID from a request to to a Mix service. |
ForgetResponse
Output message in response to a forget request.
Field | Type | Description |
---|---|---|
nuance.rpc.Status | Status | Success means the forget request is accepted. |
This is a successful response:
2023-02-08 10:47:52,523 INFO : Received response: status {
status_code: OK
status_sub_code: 200
status_details {
message: "Forgetme request is accepted, traceId: a083752c-2792-45a5-97ef-91da55b5fa3a"
}
}
See ForgetMe payload for a sample event log, and ForgetMe essentials.
The ForgetMe service does not check that the forget_id
represents a valid user or session ID. It simply writes an event log.
This request was unsuccessful as the app ID was not found or did not have the correct permissions:
2023-02-08 10:54:27,073 INFO : Received response: status {
status_code: NOT_FOUND
status_sub_code: 11
status_details {
message: "Internal error, TraceId: 4e6a3d49-c3ab-4a28-a507-94cc1ffd62ec"
}
}
Scalar value types
The data types in the proto files are mapped to equivalent types in the generated client stub files.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.