Gigya Job Openings

User Deletion AWS Integration

Skip to end of metadata
Go to start of metadata

Description

This is a step-by-step outline of how to configure an IDX export for use with Gigya GConnectors that support a User Deletion feature.

User Deletion AWS Integration

When users are deleted from the Gigya database, that information should be synced to the CMS, to ensure users are deleted there as well. There are two types of "deletion" when using a supported GConnector:

  • Delete a user from the CMS database automatically.
  • Tag a user for deletion (i.e., assign an attribute in the database that is later handled using custom code).

 

This process is done using IdentitySync, Gigya's ETL solution, as follows:

  1. IdentitySync retrieves user deletion events from Gigya's Audit Log.
  2. These events are stored in an Amazon S3 bucket in one or more DSV files that contains a list of the UIDs of the deleted users.
  3. The DSV file is uploaded into the CMS using a dedicated User Deletion module.
  4. The module deletes users from the CMS based on their Gigya UIDs.
  5. An email is sent, specifying the number of users deleted successfully, or the ones for which deletion failed.
  6. See the documentation for the specific CMS GConnector to determine where the log files of the deletion job are stored.

 

In the event that some of the users in the file were not handled by the module, the module will not retry to delete those users. In such a case, you should create a new file with those users (with a different file name), and resend that file. If all the users were not handled, the module will automatically make a retry attempt to delete the users.

This guide assumes you have already set up an Amazon S3 bucket and have the credentials prepared, and have configured access to IdentitySync.

To configure user deletion:

  1. Open IdentitySync Data Flows in Gigya's Console.

  2. In the dashboard, click Create Data Flow

  3. In the Create Data Flow window, select any value for the "Integration" and "Data Flow" drop-downs.

  4. Click Continue. As a result, the IdentitySync Studio screen opens in the dashboard.

  5. Click the Source tab.
  6. Copy the following code and paste it instead of the existing data flow: 

     

    {
        "name" : "Export deleted users from Gigya to S3",
        "description" : "account > rename > dsv > gzip > sftp",
        "steps" : [{
                "id" : "account",
                "type" : "datasource.read.gigya.audit",
                "params" : {
                    "select" : "UID",
                    "where" : "endpoint = 'accounts.deleteAccount'"
                },
                "next" : ["dsv"]
            }, {
                "id" : "dsv",
                "type" : "file.format.dsv",
                "params" : {
                    "fileName" : "GIGYA_DELETED_USERS_${now}.csv",
                    "columnSeparator" : ",",
                    "quoteFields" : true
                },
                "next" : ["s3"]
            }, {
                "id" : "s3",
                "type" : "datasource.write.amazon.s3",
                "params" : {
                    "bucketName" : "",
                    "accessKey" : "",
                    "secretKey" : "",
                    "objectKeyPrefix" : ""
                }
            }
        ]
    }
  7. Add the relevant Amazon credentials (bucket name, access key, secrey key, object key prefix). For more information, see the Component Repository.

  8. Save the dataflow and schedule the times at which to run it. You should also test the flow. For more information, see IdentitySync.
  9. Configure the User Deletion module in a supported GConnector.

 

 

 

  • No labels