Version: 1.0
Personal Data Introduction
In Commerce, every change to a user’s personal data is logged.
Personal data sets are groups of data items that are related to each other. For example, customer, addresses, and authentication information. The contents of a personal data set is dynamic. Data items are attached to each other automatically as they are created or updated.
The API allows you to fetch these logs, including the list of related data items. In other words, the data items that belong to the same personal data set.
Log entries are kept in the system for a limited time. You can configure the retention period using the Logs Time-to-live (TTL) settings API. The default retention period is 365 days for production store types and 7 days for other store types.
Personal Data Resource Types
Entity type | Endpoint | Documentation |
---|---|---|
customer | v2/customers/{id} | Customers |
account | v2/accounts/{id} | Accounts |
account-member | v2/account-members/{id} | Account Members |
account-membership | v2/accounts/{accountId}/account-memberships/{id} | Account Memberships |
address | v2/customers/{customerId}/addresses/{id} ; v2/accounts/{accountId}/addresses/{id} | Addresses |
user-authentication-info | v2/authentication-realms/{realmId}/user-authentication-info/{id} | User Authentication Info |
user-authentication-oidc-profile-info | v2/authentication-realms/{authenticationRealmId}/user-authentication-info/{userAuthenticationInfoId}/user-authentication-oidc-profile-info/{id} | User Authentication OIDC Profile Info |
user-authentication-password-profile-info | v2/authentication-realms/{authenticationRealmId}/user-authentication-info/{userAuthenticationInfoId}/user-authentication-password-profile-info/{id} | User Authentication Password Profile Info |
order | v2/orders/{id} | Orders |
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
---|---|
HTTP Authorization Scheme: | bearer |