symbols:
# region models
'DtoExtendConfigDTO@jv.gdpr.mod':
id: 'DtoExtendConfigDTO@jv.gdpr.mod'
name: 'DtoExtendConfigDTO'
type: 'model'
fields:
'appName':
type: 'String'
required: true
description: |-
extend app name
'namespace':
type: 'String'
required: true
description: |-
extend app namespace
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoExtendConfigDTO.java'
'DtoFinishedDataDeletion@jv.gdpr.mod':
id: 'DtoFinishedDataDeletion@jv.gdpr.mod'
name: 'DtoFinishedDataDeletion'
type: 'model'
fields:
'finishedDate':
type: 'String'
required: true
description: |-
Finished deletion date
'requestDate':
type: 'String'
required: true
description: |-
Request deletion date
'status':
type: 'String'
required: true
description: |-
Status of request
'userId':
type: 'String'
required: true
description: |-
User Id. This userId will be anonymized automatically after 7 days from the **Success** deletion
'failedMessage':
type: 'String'
required: false
description: |-
Failed message if status is Failed
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoFinishedDataDeletion.java'
'DtoFinishedDataRequest@jv.gdpr.mod':
id: 'DtoFinishedDataRequest@jv.gdpr.mod'
name: 'DtoFinishedDataRequest'
type: 'model'
fields:
'finishedDate':
type: 'String'
required: true
description: |-
Finished date
'requestDate':
type: 'String'
required: true
description: |-
Request date
'requestId':
type: 'String'
required: true
description: |-
Request id
'status':
type: 'String'
required: true
description: |-
Status of request
'userId':
type: 'String'
required: true
'dataExpirationDate':
type: 'String'
required: false
description: |-
The expiration date of generated data, it was 28 days after finishedDate. Available only if the status is Completed
'failedMessage':
type: 'String'
required: false
description: |-
Failed message if status is Failed
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoFinishedDataRequest.java'
'DtoListFinishedDataDeletion@jv.gdpr.mod':
id: 'DtoListFinishedDataDeletion@jv.gdpr.mod'
name: 'DtoListFinishedDataDeletion'
type: 'model'
fields:
'data':
type: 'List<DtoFinishedDataDeletion>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoListFinishedDataDeletion.java'
'DtoListFinishedDataRequests@jv.gdpr.mod':
id: 'DtoListFinishedDataRequests@jv.gdpr.mod'
name: 'DtoListFinishedDataRequests'
type: 'model'
fields:
'data':
type: 'List<DtoFinishedDataRequest>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoListFinishedDataRequests.java'
'DtoPlatformAccountClosureClientRequest@jv.gdpr.mod':
id: 'DtoPlatformAccountClosureClientRequest@jv.gdpr.mod'
name: 'DtoPlatformAccountClosureClientRequest'
type: 'model'
fields:
'bpCert':
type: 'String'
required: false
description: |-
required for xbox
'bpCertFileName':
type: 'String'
required: false
description: |-
required for xbox
'clientId':
type: 'String'
required: false
description: |-
required for psn
'password':
type: 'String'
required: false
description: |-
required for xbox
'publisherKey':
type: 'String'
required: false
description: |-
required for steam
'sandboxId':
type: 'String'
required: false
description: |-
required for xbox
'secret':
type: 'String'
required: false
description: |-
required for psn
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoPlatformAccountClosureClientRequest.java'
'DtoPlatformAccountClosureClientResponse@jv.gdpr.mod':
id: 'DtoPlatformAccountClosureClientResponse@jv.gdpr.mod'
name: 'DtoPlatformAccountClosureClientResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'platform':
type: 'String'
required: true
'updatedAt':
type: 'Long'
required: true
'bpCertExpireAt':
type: 'Long'
required: false
'bpCertFileName':
type: 'String'
required: false
'clientId':
type: 'String'
required: false
'publisherKey':
type: 'String'
required: false
'sandboxId':
type: 'String'
required: false
'secret':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoPlatformAccountClosureClientResponse.java'
'DtoPlatformAccountClosureClientsResponse@jv.gdpr.mod':
id: 'DtoPlatformAccountClosureClientsResponse@jv.gdpr.mod'
name: 'DtoPlatformAccountClosureClientsResponse'
type: 'model'
fields:
'data':
type: 'List<DtoPlatformAccountClosureClientResponse>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoPlatformAccountClosureClientsResponse.java'
'DtoPlatformAccountClosureMockRequest@jv.gdpr.mod':
id: 'DtoPlatformAccountClosureMockRequest@jv.gdpr.mod'
name: 'DtoPlatformAccountClosureMockRequest'
type: 'model'
fields:
'platformUserId':
type: 'String'
required: true
'sandbox':
type: 'String'
required: true
'startImmediately':
type: 'Boolean'
required: true
description: |-
start the account closure process immediately
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoPlatformAccountClosureMockRequest.java'
'DtoS2SDataRequestSummary@jv.gdpr.mod':
id: 'DtoS2SDataRequestSummary@jv.gdpr.mod'
name: 'DtoS2SDataRequestSummary'
type: 'model'
fields:
'status':
type: 'String'
required: true
description: |-
Status of the request
'failedMessage':
type: 'String'
required: false
description: |-
Failed message if status is Failed
'url':
type: 'String'
required: false
description: |-
Download url if status is Completed
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoS2SDataRequestSummary.java'
'DtoServiceConfigDTO@jv.gdpr.mod':
id: 'DtoServiceConfigDTO@jv.gdpr.mod'
name: 'DtoServiceConfigDTO'
type: 'model'
fields:
'protocol':
type: 'String'
required: true
description: |-
protocol type
'skipAck':
type: 'Boolean'
required: false
description: |-
skip waiting for ack event from this service, used in "EVENT" protocol only.
'url':
type: 'String'
required: false
description: |-
url of the service with port number, required in "GRPC" protocol
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoServiceConfigDTO.java'
'DtoServiceConfigurationDTO@jv.gdpr.mod':
id: 'DtoServiceConfigurationDTO@jv.gdpr.mod'
name: 'DtoServiceConfigurationDTO'
type: 'model'
fields:
'id':
type: 'String'
required: true
description: |-
service id
'type':
type: 'String'
required: true
description: |-
service type
'extendConfig':
type: 'DtoExtendConfigDTO'
required: false
description: |-
extend configuration detail, required when "type" is "EXTEND"
'serviceConfig':
type: 'DtoServiceConfigDTO'
required: false
description: |-
service configuration detail, required when "type" is "SERVICE"
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoServiceConfigurationDTO.java'
'DtoServiceConfigurationUpdateRequest@jv.gdpr.mod':
id: 'DtoServiceConfigurationUpdateRequest@jv.gdpr.mod'
name: 'DtoServiceConfigurationUpdateRequest'
type: 'model'
fields:
'services':
type: 'List<DtoServiceConfigurationDTO>'
required: true
description: |-
list of services
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoServiceConfigurationUpdateRequest.java'
'DtoServicesConfigurationResponse@jv.gdpr.mod':
id: 'DtoServicesConfigurationResponse@jv.gdpr.mod'
name: 'DtoServicesConfigurationResponse'
type: 'model'
fields:
'services':
type: 'List<DtoServiceConfigurationDTO>'
required: true
description: |-
list of services
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoServicesConfigurationResponse.java'
'DtoUserPlatformAccountClosureHistoriesResponse@jv.gdpr.mod':
id: 'DtoUserPlatformAccountClosureHistoriesResponse@jv.gdpr.mod'
name: 'DtoUserPlatformAccountClosureHistoriesResponse'
type: 'model'
fields:
'data':
type: 'List<DtoUserPlatformAccountClosureHistory>'
required: true
'pagination':
type: 'ModelsPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoUserPlatformAccountClosureHistoriesResponse.java'
'DtoUserPlatformAccountClosureHistory@jv.gdpr.mod':
id: 'DtoUserPlatformAccountClosureHistory@jv.gdpr.mod'
name: 'DtoUserPlatformAccountClosureHistory'
type: 'model'
fields:
'closedDate':
type: 'Long'
required: true
'environment':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'platform':
type: 'String'
required: true
'platformUserId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoUserPlatformAccountClosureHistory.java'
'DtoXboxBPCertValidationRequest@jv.gdpr.mod':
id: 'DtoXboxBPCertValidationRequest@jv.gdpr.mod'
name: 'DtoXboxBPCertValidationRequest'
type: 'model'
fields:
'bpCert':
type: 'String'
required: true
'password':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoXboxBPCertValidationRequest.java'
'DtoXboxBPCertValidationResponse@jv.gdpr.mod':
id: 'DtoXboxBPCertValidationResponse@jv.gdpr.mod'
name: 'DtoXboxBPCertValidationResponse'
type: 'model'
fields:
'expirationDate':
type: 'Long'
required: true
'expired':
type: 'Boolean'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/DtoXboxBPCertValidationResponse.java'
'ModelsDataRetrievalResponse@jv.gdpr.mod':
id: 'ModelsDataRetrievalResponse@jv.gdpr.mod'
name: 'ModelsDataRetrievalResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'requestDate':
type: 'String'
required: true
'userID':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsDataRetrievalResponse.java'
'ModelsDeletionData@jv.gdpr.mod':
id: 'ModelsDeletionData@jv.gdpr.mod'
name: 'ModelsDeletionData'
type: 'model'
fields:
'displayName':
type: 'String'
required: true
'requestDate':
type: 'String'
required: true
'status':
type: 'String'
required: true
'uniqueDisplayName':
type: 'String'
required: true
'userID':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsDeletionData.java'
'ModelsDeletionStatus@jv.gdpr.mod':
id: 'ModelsDeletionStatus@jv.gdpr.mod'
name: 'ModelsDeletionStatus'
type: 'model'
fields:
'deletionDate':
type: 'String'
required: true
'deletionStatus':
type: 'Boolean'
required: true
'displayName':
type: 'String'
required: true
'status':
type: 'String'
required: true
'userID':
type: 'String'
required: true
'executionDate':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsDeletionStatus.java'
'ModelsListDeletionDataResponse@jv.gdpr.mod':
id: 'ModelsListDeletionDataResponse@jv.gdpr.mod'
name: 'ModelsListDeletionDataResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsDeletionData>'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsListDeletionDataResponse.java'
'ModelsListPersonalDataResponse@jv.gdpr.mod':
id: 'ModelsListPersonalDataResponse@jv.gdpr.mod'
name: 'ModelsListPersonalDataResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsPersonalData>'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsListPersonalDataResponse.java'
'ModelsPagination@jv.gdpr.mod':
id: 'ModelsPagination@jv.gdpr.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'first':
type: 'String'
required: true
'last':
type: 'String'
required: true
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsPagination.java'
'ModelsPersonalData@jv.gdpr.mod':
id: 'ModelsPersonalData@jv.gdpr.mod'
name: 'ModelsPersonalData'
type: 'model'
fields:
'dataExpirationDate':
type: 'String'
required: true
'displayName':
type: 'String'
required: true
'requestDate':
type: 'String'
required: true
'serviceErrors':
type: 'Map<String, String>'
required: true
'serviceStatuses':
type: 'Map<String, String>'
required: true
'status':
type: 'String'
required: true
'userID':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsPersonalData.java'
'ModelsRequestDeleteResponse@jv.gdpr.mod':
id: 'ModelsRequestDeleteResponse@jv.gdpr.mod'
name: 'ModelsRequestDeleteResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'userID':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsRequestDeleteResponse.java'
'ModelsS2SDataRetrievalResponse@jv.gdpr.mod':
id: 'ModelsS2SDataRetrievalResponse@jv.gdpr.mod'
name: 'ModelsS2SDataRetrievalResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'requestDate':
type: 'String'
required: true
'requestId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsS2SDataRetrievalResponse.java'
'ModelsS2SRequestDeleteResponse@jv.gdpr.mod':
id: 'ModelsS2SRequestDeleteResponse@jv.gdpr.mod'
name: 'ModelsS2SRequestDeleteResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsS2SRequestDeleteResponse.java'
'ModelsS2SUserDataURL@jv.gdpr.mod':
id: 'ModelsS2SUserDataURL@jv.gdpr.mod'
name: 'ModelsS2SUserDataURL'
type: 'model'
fields:
'url':
type: 'String'
required: true
description: |-
Download url if status is Completed
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsS2SUserDataURL.java'
'ModelsUserDataURL@jv.gdpr.mod':
id: 'ModelsUserDataURL@jv.gdpr.mod'
name: 'ModelsUserDataURL'
type: 'model'
fields:
'url':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsUserDataURL.java'
'ModelsUserPersonalData@jv.gdpr.mod':
id: 'ModelsUserPersonalData@jv.gdpr.mod'
name: 'ModelsUserPersonalData'
type: 'model'
fields:
'dataExpirationDate':
type: 'String'
required: true
'requestDate':
type: 'String'
required: true
'status':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsUserPersonalData.java'
'ModelsUserPersonalDataResponse@jv.gdpr.mod':
id: 'ModelsUserPersonalDataResponse@jv.gdpr.mod'
name: 'ModelsUserPersonalDataResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsUserPersonalData>'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ModelsUserPersonalDataResponse.java'
'ResponseError@jv.gdpr.mod':
id: 'ResponseError@jv.gdpr.mod'
name: 'ResponseError'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
'errorMessage':
type: 'String'
required: true
'messageVariables':
type: 'Map<String, String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/models/ResponseError.java'
# endregion models
# region functions
'AdminCancelUserAccountDeletionRequest@jv.gdpr.fun':
id: 'AdminCancelUserAccountDeletionRequest@jv.gdpr.fun'
name: 'AdminCancelUserAccountDeletionRequest'
type: 'function'
description: |-
Cancel user's account deletion request
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/AdminCancelUserAccountDeletionRequest.java'
example: |-
try {
final AdminCancelUserAccountDeletionRequest operation = AdminCancelUserAccountDeletionRequest.builder()
.build(
namespace,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
wrapper.adminCancelUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'cancel'
- 'data'
- 'deletion'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'AdminCancelUserPersonalDataRequest@jv.gdpr.fun':
id: 'AdminCancelUserPersonalDataRequest@jv.gdpr.fun'
name: 'AdminCancelUserPersonalDataRequest'
type: 'function'
description: |-
Cancel user's personal data requests
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'requestDate':
type: 'String'
required: true
description: |-
Request date in RFC3339 format
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/AdminCancelUserPersonalDataRequest.java'
example: |-
try {
final AdminCancelUserPersonalDataRequest operation = AdminCancelUserPersonalDataRequest.builder()
.build(
namespace,
requestDate,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
wrapper.adminCancelUserPersonalDataRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'cancel'
- 'data'
- 'personal'
- 'request'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [DELETE]'
'AdminDeletePlatformAccountClosureClient@jv.gdpr.fun':
id: 'AdminDeletePlatformAccountClosureClient@jv.gdpr.fun'
name: 'AdminDeletePlatformAccountClosureClient'
type: 'function'
description: |-
Delete platform account closure client.
The namespace should be **publisher or studio namespace**
-------
Platform:
- steamnetwork
- xbox
- psn
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'platform':
type: 'String'
required: true
description: |-
3rd party platform
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminDeletePlatformAccountClosureClient.java'
example: |-
try {
final AdminDeletePlatformAccountClosureClient operation = AdminDeletePlatformAccountClosureClient.builder()
.build(
namespace,
platform,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
wrapper.adminDeletePlatformAccountClosureClient(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'delete'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminGeneratePersonalDataURL@jv.gdpr.fun':
id: 'AdminGeneratePersonalDataURL@jv.gdpr.fun'
name: 'AdminGeneratePersonalDataURL'
type: 'function'
description: |-
Required permission `ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]` and scope `account`
If admin request data for themselves, password is need to be set
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'password':
type: 'String'
required: false
description: |-
If admin request data for themselves, then password is required
'requestDate':
type: 'String'
required: true
description: |-
Request date in RFC3339 format
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'ModelsUserDataURL'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/AdminGeneratePersonalDataURL.java'
example: |-
try {
final AdminGeneratePersonalDataURL operation = AdminGeneratePersonalDataURL.builder()
.password(...)
.build(
namespace,
requestDate,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsUserDataURL response = wrapper.adminGeneratePersonalDataURL(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetListDeletionDataRequest@jv.gdpr.fun':
id: 'AdminGetListDeletionDataRequest@jv.gdpr.fun'
name: 'AdminGetListDeletionDataRequest'
type: 'function'
description: |-
Retrieve all user's account deletion requests in specified date
Scope: account
arguments:
'after':
type: 'String'
required: false
description: |-
The day in UTC format to get deletion request list after that. format : YYYY-MM-DD
'before':
type: 'String'
required: false
description: |-
The day in UTC format to get deletion request list before that. format : YYYY-MM-DD
'limit':
type: 'Integer'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
The start position that points to query data
'requestDate':
type: 'String'
required: false
description: |-
The day in UTC of the deletion request. format : YYYY-MM-DD. Default : today time in UTC.
return_type: 'ModelsListDeletionDataResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/AdminGetListDeletionDataRequest.java'
example: |-
try {
final AdminGetListDeletionDataRequest operation = AdminGetListDeletionDataRequest.builder()
.after(...)
.before(...)
.limit(...)
.offset(...)
.requestDate(...)
.build(
namespace,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsListDeletionDataResponse response = wrapper.adminGetListDeletionDataRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'list'
- 'request'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'AdminGetListPersonalDataRequest@jv.gdpr.fun':
id: 'AdminGetListPersonalDataRequest@jv.gdpr.fun'
name: 'AdminGetListPersonalDataRequest'
type: 'function'
description: |-
Get list personal data requests
Scope: account
arguments:
'limit':
type: 'Integer'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
The start position that points to query data
'requestDate':
type: 'String'
required: false
description: |-
request date with format YYYY-MM-DD. Default value today UTC
return_type: 'ModelsListPersonalDataResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/AdminGetListPersonalDataRequest.java'
example: |-
try {
final AdminGetListPersonalDataRequest operation = AdminGetListPersonalDataRequest.builder()
.limit(...)
.offset(...)
.requestDate(...)
.build(
namespace,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsListPersonalDataResponse response = wrapper.adminGetListPersonalDataRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'data'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER [READ]'
'AdminGetPlatformAccountClosureClient@jv.gdpr.fun':
id: 'AdminGetPlatformAccountClosureClient@jv.gdpr.fun'
name: 'AdminGetPlatformAccountClosureClient'
type: 'function'
description: |-
Get platform account closure config.
The namespace should be **publisher or studio namespace**
----------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'platform':
type: 'String'
required: true
description: |-
3rd party platform
return_type: 'DtoPlatformAccountClosureClientResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminGetPlatformAccountClosureClient.java'
example: |-
try {
final AdminGetPlatformAccountClosureClient operation = AdminGetPlatformAccountClosureClient.builder()
.build(
namespace,
platform,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
final DtoPlatformAccountClosureClientResponse response = wrapper.adminGetPlatformAccountClosureClient(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetPlatformAccountClosureClients@jv.gdpr.fun':
id: 'AdminGetPlatformAccountClosureClients@jv.gdpr.fun'
name: 'AdminGetPlatformAccountClosureClients'
type: 'function'
description: |-
Get platform account closure configs.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoPlatformAccountClosureClientsResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminGetPlatformAccountClosureClients.java'
example: |-
try {
final AdminGetPlatformAccountClosureClients operation = AdminGetPlatformAccountClosureClients.builder()
.build(
namespace,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
final DtoPlatformAccountClosureClientsResponse response = wrapper.adminGetPlatformAccountClosureClients(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'client'
- 'clients'
- 'closure'
- 'get'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetPlatformAccountClosureServicesConfiguration@jv.gdpr.fun':
id: 'AdminGetPlatformAccountClosureServicesConfiguration@jv.gdpr.fun'
name: 'AdminGetPlatformAccountClosureServicesConfiguration'
type: 'function'
description: |-
Get registered platform account closure services configuration.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoServicesConfigurationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminGetPlatformAccountClosureServicesConfiguration.java'
example: |-
try {
final AdminGetPlatformAccountClosureServicesConfiguration operation = AdminGetPlatformAccountClosureServicesConfiguration.builder()
.build(
namespace,
);
final Configuration wrapper = new Configuration(sdk);
final DtoServicesConfigurationResponse response = wrapper.adminGetPlatformAccountClosureServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'get'
- 'platform'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetServicesConfiguration@jv.gdpr.fun':
id: 'AdminGetServicesConfiguration@jv.gdpr.fun'
name: 'AdminGetServicesConfiguration'
type: 'function'
description: |-
Get Registered Services Configuration.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoServicesConfigurationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminGetServicesConfiguration.java'
example: |-
try {
final AdminGetServicesConfiguration operation = AdminGetServicesConfiguration.builder()
.build(
namespace,
);
final Configuration wrapper = new Configuration(sdk);
final DtoServicesConfigurationResponse response = wrapper.adminGetServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'get'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'AdminGetUserAccountDeletionRequest@jv.gdpr.fun':
id: 'AdminGetUserAccountDeletionRequest@jv.gdpr.fun'
name: 'AdminGetUserAccountDeletionRequest'
type: 'function'
description: |-
Retrieve specific user's account deletion request
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'ModelsDeletionData'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/AdminGetUserAccountDeletionRequest.java'
example: |-
try {
final AdminGetUserAccountDeletionRequest operation = AdminGetUserAccountDeletionRequest.builder()
.build(
namespace,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsDeletionData response = wrapper.adminGetUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'get'
- 'request'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetUserPersonalDataRequests@jv.gdpr.fun':
id: 'AdminGetUserPersonalDataRequests@jv.gdpr.fun'
name: 'AdminGetUserPersonalDataRequests'
type: 'function'
description: |-
Get user's personal data requests
Scope: account
arguments:
'limit':
type: 'Integer'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
The start position that points to query data
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'ModelsUserPersonalDataResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/AdminGetUserPersonalDataRequests.java'
example: |-
try {
final AdminGetUserPersonalDataRequests operation = AdminGetUserPersonalDataRequests.builder()
.limit(...)
.offset(...)
.build(
namespace,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsUserPersonalDataResponse response = wrapper.adminGetUserPersonalDataRequests(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'data'
- 'get'
- 'personal'
- 'requests'
- 'retrieval'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [READ]'
'AdminGetUserPlatformAccountClosureHistories@jv.gdpr.fun':
id: 'AdminGetUserPlatformAccountClosureHistories@jv.gdpr.fun'
name: 'AdminGetUserPlatformAccountClosureHistories'
type: 'function'
description: |-
Get user's platform account closure histories.
Scope: account
------
Supported platforms:
- psn
- steamnetwork
- xbox
arguments:
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'platform':
type: 'String'
required: false
description: |-
3rd party platform
'userId':
type: 'String'
required: false
description: |-
IAM ID of the user
return_type: 'DtoUserPlatformAccountClosureHistoriesResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_history.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureHistory.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_history/AdminGetUserPlatformAccountClosureHistories.java'
example: |-
try {
final AdminGetUserPlatformAccountClosureHistories operation = AdminGetUserPlatformAccountClosureHistories.builder()
.limit(...)
.offset(...)
.platform(...)
.userId(...)
.build(
namespace,
);
final PlatformAccountClosureHistory wrapper = new PlatformAccountClosureHistory(sdk);
final DtoUserPlatformAccountClosureHistoriesResponse response = wrapper.adminGetUserPlatformAccountClosureHistories(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'closure'
- 'get'
- 'histories'
- 'history'
- 'platform'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER [READ]'
'AdminMockPlatformAccountClosureData@jv.gdpr.fun':
id: 'AdminMockPlatformAccountClosureData@jv.gdpr.fun'
name: 'AdminMockPlatformAccountClosureData'
type: 'function'
description: |-
Mock platform account closure data.
-----
**This is only for testing**
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'body':
type: 'DtoPlatformAccountClosureMockRequest'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
'platform':
type: 'String'
required: true
description: |-
3rd party platform
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminMockPlatformAccountClosureData.java'
example: |-
try {
final AdminMockPlatformAccountClosureData operation = AdminMockPlatformAccountClosureData.builder()
.build(
body,
namespace,
platform,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
wrapper.adminMockPlatformAccountClosureData(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'data'
- 'mock'
- 'platform'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminRequestDataRetrieval@jv.gdpr.fun':
id: 'AdminRequestDataRetrieval@jv.gdpr.fun'
name: 'AdminRequestDataRetrieval'
type: 'function'
description: |-
Submit user personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'password':
type: 'String'
required: false
description: |-
IAM password of the user, required if admin requests their own data
'userId':
type: 'String'
required: true
description: |-
IAM user ID
return_type: 'ModelsDataRetrievalResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/AdminRequestDataRetrieval.java'
example: |-
try {
final AdminRequestDataRetrieval operation = AdminRequestDataRetrieval.builder()
.password(...)
.build(
namespace,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsDataRetrievalResponse response = wrapper.adminRequestDataRetrieval(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'data'
- 'request'
- 'retrieval'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'AdminResetPlatformAccountClosureServicesConfiguration@jv.gdpr.fun':
id: 'AdminResetPlatformAccountClosureServicesConfiguration@jv.gdpr.fun'
name: 'AdminResetPlatformAccountClosureServicesConfiguration'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset registered platform account closure services configuration to use the default configuration.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminResetPlatformAccountClosureServicesConfiguration.java'
example: |-
try {
final AdminResetPlatformAccountClosureServicesConfiguration operation = AdminResetPlatformAccountClosureServicesConfiguration.builder()
.build(
namespace,
);
final Configuration wrapper = new Configuration(sdk);
wrapper.adminResetPlatformAccountClosureServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminResetServicesConfiguration@jv.gdpr.fun':
id: 'AdminResetServicesConfiguration@jv.gdpr.fun'
name: 'AdminResetServicesConfiguration'
type: 'function'
description: |-
**[TEST FACILITY ONLY]**
Reset Registered Services Configuration to use the default configuration.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminResetServicesConfiguration.java'
example: |-
try {
final AdminResetServicesConfiguration operation = AdminResetServicesConfiguration.builder()
.build(
namespace,
);
final Configuration wrapper = new Configuration(sdk);
wrapper.adminResetServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'reset'
- 'services'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [DELETE]'
'AdminSubmitUserAccountDeletionRequest@jv.gdpr.fun':
id: 'AdminSubmitUserAccountDeletionRequest@jv.gdpr.fun'
name: 'AdminSubmitUserAccountDeletionRequest'
type: 'function'
description: |-
Submit user's account deletion request.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'ModelsRequestDeleteResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/AdminSubmitUserAccountDeletionRequest.java'
example: |-
try {
final AdminSubmitUserAccountDeletionRequest operation = AdminSubmitUserAccountDeletionRequest.builder()
.build(
namespace,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsRequestDeleteResponse response = wrapper.adminSubmitUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'data'
- 'deletion'
- 'request'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:{userId} [CREATE]'
'AdminUpdatePlatformAccountClosureClient@jv.gdpr.fun':
id: 'AdminUpdatePlatformAccountClosureClient@jv.gdpr.fun'
name: 'AdminUpdatePlatformAccountClosureClient'
type: 'function'
description: |-
Update platform account closure client.
The namespace should be the **publisher or studio namespace**.
------
Platform:
- steamnetwork
- xbox
- psn
Scope: account
arguments:
'body':
type: 'DtoPlatformAccountClosureClientRequest'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
'platform':
type: 'String'
required: true
description: |-
3rd party platform
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminUpdatePlatformAccountClosureClient.java'
example: |-
try {
final AdminUpdatePlatformAccountClosureClient operation = AdminUpdatePlatformAccountClosureClient.builder()
.build(
body,
namespace,
platform,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
wrapper.adminUpdatePlatformAccountClosureClient(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'client'
- 'closure'
- 'platform'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminUpdatePlatformAccountClosureServicesConfiguration@jv.gdpr.fun':
id: 'AdminUpdatePlatformAccountClosureServicesConfiguration@jv.gdpr.fun'
name: 'AdminUpdatePlatformAccountClosureServicesConfiguration'
type: 'function'
description: |-
Update registered platform account closure services configuration.
Scope: account
arguments:
'body':
type: 'DtoServiceConfigurationUpdateRequest'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoServiceConfigurationUpdateRequest'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminUpdatePlatformAccountClosureServicesConfiguration.java'
example: |-
try {
final AdminUpdatePlatformAccountClosureServicesConfiguration operation = AdminUpdatePlatformAccountClosureServicesConfiguration.builder()
.build(
body,
namespace,
);
final Configuration wrapper = new Configuration(sdk);
final DtoServiceConfigurationUpdateRequest response = wrapper.adminUpdatePlatformAccountClosureServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'closure'
- 'configuration'
- 'platform'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminUpdateServicesConfiguration@jv.gdpr.fun':
id: 'AdminUpdateServicesConfiguration@jv.gdpr.fun'
name: 'AdminUpdateServicesConfiguration'
type: 'function'
description: |-
Update Registered Services Configuration.
Scope: account
arguments:
'body':
type: 'DtoServiceConfigurationUpdateRequest'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoServiceConfigurationUpdateRequest'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/AdminUpdateServicesConfiguration.java'
example: |-
try {
final AdminUpdateServicesConfiguration operation = AdminUpdateServicesConfiguration.builder()
.build(
body,
namespace,
);
final Configuration wrapper = new Configuration(sdk);
final DtoServiceConfigurationUpdateRequest response = wrapper.adminUpdateServicesConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'services'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [UPDATE]'
'AdminValidateXboxBPCertFile@jv.gdpr.fun':
id: 'AdminValidateXboxBPCertFile@jv.gdpr.fun'
name: 'AdminValidateXboxBPCertFile'
type: 'function'
description: |-
Check xbox BP cert file whether it's expired and return expiration date
arguments:
'body':
type: 'DtoXboxBPCertValidationRequest'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'DtoXboxBPCertValidationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.platform_account_closure_client.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/PlatformAccountClosureClient.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/platform_account_closure_client/AdminValidateXboxBPCertFile.java'
example: |-
try {
final AdminValidateXboxBPCertFile operation = AdminValidateXboxBPCertFile.builder()
.build(
body,
namespace,
);
final PlatformAccountClosureClient wrapper = new PlatformAccountClosureClient(sdk);
final DtoXboxBPCertValidationResponse response = wrapper.adminValidateXboxBPCertFile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'admin'
- 'bp'
- 'cert'
- 'client'
- 'closure'
- 'file'
- 'platform'
- 'validate'
- 'xbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION [READ]'
'DeleteAdminEmailConfiguration@jv.gdpr.fun':
id: 'DeleteAdminEmailConfiguration@jv.gdpr.fun'
name: 'DeleteAdminEmailConfiguration'
type: 'function'
description: |-
Delete a list of admin email addresses to stop receiving personal data request notification.
Scope: account
arguments:
'emails':
type: 'List<String>'
required: true
description: |-
list of admin email to delete
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/DeleteAdminEmailConfiguration.java'
example: |-
try {
final DeleteAdminEmailConfiguration operation = DeleteAdminEmailConfiguration.builder()
.build(
emails,
namespace,
);
final Configuration wrapper = new Configuration(sdk);
wrapper.deleteAdminEmailConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'email'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [DELETE]'
'GetAdminEmailConfiguration@jv.gdpr.fun':
id: 'GetAdminEmailConfiguration@jv.gdpr.fun'
name: 'GetAdminEmailConfiguration'
type: 'function'
description: |-
Get list of admin email address configuration.
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'List<String>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/GetAdminEmailConfiguration.java'
example: |-
try {
final GetAdminEmailConfiguration operation = GetAdminEmailConfiguration.builder()
.build(
namespace,
);
final Configuration wrapper = new Configuration(sdk);
final List<String> response = wrapper.getAdminEmailConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'email'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [READ]'
'PublicCancelMyAccountDeletionRequest@jv.gdpr.fun':
id: 'PublicCancelMyAccountDeletionRequest@jv.gdpr.fun'
name: 'PublicCancelMyAccountDeletionRequest'
type: 'function'
description: |-
Cancel my account deletion request
Requires valid user access token
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicCancelMyAccountDeletionRequest.java'
example: |-
try {
final PublicCancelMyAccountDeletionRequest operation = PublicCancelMyAccountDeletionRequest.builder()
.build();
final DataDeletion wrapper = new DataDeletion(sdk);
wrapper.publicCancelMyAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
'PublicCancelUserAccountDeletionRequest@jv.gdpr.fun':
id: 'PublicCancelUserAccountDeletionRequest@jv.gdpr.fun'
name: 'PublicCancelUserAccountDeletionRequest'
type: 'function'
description: |-
Cancel user's account deletion request
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicCancelUserAccountDeletionRequest.java'
example: |-
try {
final PublicCancelUserAccountDeletionRequest operation = PublicCancelUserAccountDeletionRequest.builder()
.build(
namespace,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
wrapper.publicCancelUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'cancel'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'user'
'PublicCancelUserPersonalDataRequest@jv.gdpr.fun':
id: 'PublicCancelUserPersonalDataRequest@jv.gdpr.fun'
name: 'PublicCancelUserPersonalDataRequest'
type: 'function'
description: |-
Cancel user's personal data requests
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'requestDate':
type: 'String'
required: true
description: |-
Request date in RFC3339 format
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/PublicCancelUserPersonalDataRequest.java'
example: |-
try {
final PublicCancelUserPersonalDataRequest operation = PublicCancelUserPersonalDataRequest.builder()
.build(
namespace,
requestDate,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
wrapper.publicCancelUserPersonalDataRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'cancel'
- 'data'
- 'personal'
- 'public'
- 'request'
- 'retrieval'
- 'user'
'PublicGeneratePersonalDataURL@jv.gdpr.fun':
id: 'PublicGeneratePersonalDataURL@jv.gdpr.fun'
name: 'PublicGeneratePersonalDataURL'
type: 'function'
description: |-
Generate personal data download url
Requires valid user access token
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'password':
type: 'String'
required: true
description: |-
IAM password of the user
'requestDate':
type: 'String'
required: true
description: |-
Request date in RFC3339 format
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'ModelsUserDataURL'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/PublicGeneratePersonalDataURL.java'
example: |-
try {
final PublicGeneratePersonalDataURL operation = PublicGeneratePersonalDataURL.builder()
.build(
namespace,
password,
requestDate,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsUserDataURL response = wrapper.publicGeneratePersonalDataURL(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'generate'
- 'personal'
- 'public'
- 'retrieval'
- 'url'
'PublicGetMyAccountDeletionStatus@jv.gdpr.fun':
id: 'PublicGetMyAccountDeletionStatus@jv.gdpr.fun'
name: 'PublicGetMyAccountDeletionStatus'
type: 'function'
description: |-
Retrieve my account deletion status
Requires valid user access token
return_type: 'ModelsDeletionStatus'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicGetMyAccountDeletionStatus.java'
example: |-
try {
final PublicGetMyAccountDeletionStatus operation = PublicGetMyAccountDeletionStatus.builder()
.build();
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsDeletionStatus response = wrapper.publicGetMyAccountDeletionStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'my'
- 'public'
- 'status'
'PublicGetUserAccountDeletionStatus@jv.gdpr.fun':
id: 'PublicGetUserAccountDeletionStatus@jv.gdpr.fun'
name: 'PublicGetUserAccountDeletionStatus'
type: 'function'
description: |-
Retrieve specific user's account deletion status
Requires valid user access token
Scope: account
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'ModelsDeletionStatus'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicGetUserAccountDeletionStatus.java'
example: |-
try {
final PublicGetUserAccountDeletionStatus operation = PublicGetUserAccountDeletionStatus.builder()
.build(
namespace,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsDeletionStatus response = wrapper.publicGetUserAccountDeletionStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'get'
- 'public'
- 'status'
- 'user'
'PublicGetUserPersonalDataRequests@jv.gdpr.fun':
id: 'PublicGetUserPersonalDataRequests@jv.gdpr.fun'
name: 'PublicGetUserPersonalDataRequests'
type: 'function'
description: |-
Get user's personal data requests
Requires valid user access token
Scope: account
arguments:
'limit':
type: 'Integer'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'offset':
type: 'Integer'
required: false
description: |-
The start position that points to query data
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'ModelsUserPersonalDataResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/PublicGetUserPersonalDataRequests.java'
example: |-
try {
final PublicGetUserPersonalDataRequests operation = PublicGetUserPersonalDataRequests.builder()
.limit(...)
.offset(...)
.build(
namespace,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsUserPersonalDataResponse response = wrapper.publicGetUserPersonalDataRequests(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'get'
- 'personal'
- 'public'
- 'requests'
- 'retrieval'
- 'user'
'PublicRequestDataRetrieval@jv.gdpr.fun':
id: 'PublicRequestDataRetrieval@jv.gdpr.fun'
name: 'PublicRequestDataRetrieval'
type: 'function'
description: |-
Submit personal data retrieval request.
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'languageTag':
type: 'String'
required: false
description: |-
Language tag
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'password':
type: 'String'
required: true
description: |-
IAM password of the user
'userId':
type: 'String'
required: true
description: |-
IAM id of the user
return_type: 'ModelsDataRetrievalResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrieval.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval/PublicRequestDataRetrieval.java'
example: |-
try {
final PublicRequestDataRetrieval operation = PublicRequestDataRetrieval.builder()
.languageTag(...)
.build(
namespace,
password,
userId,
);
final DataRetrieval wrapper = new DataRetrieval(sdk);
final ModelsDataRetrievalResponse response = wrapper.publicRequestDataRetrieval(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'public'
- 'request'
- 'retrieval'
'PublicSubmitMyAccountDeletionRequest@jv.gdpr.fun':
id: 'PublicSubmitMyAccountDeletionRequest@jv.gdpr.fun'
name: 'PublicSubmitMyAccountDeletionRequest'
type: 'function'
description: |-
Submit my account deletion requests.
Requires valid user access token
This is for in-game only and require a valid platformId and platform token. If a full account is not logged by 3rd platform, then please use [/gdpr/public/namespaces/{namespace}/users/{userId}/deletions](#operations-Data_Deletion-PublicSubmitUserAccountDeletionRequest)
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'platformId':
type: 'String'
required: true
description: |-
Platform ID which used to generate current token
'platformToken':
type: 'String'
required: true
description: |-
Platform token of current logged platform
return_type: 'ModelsRequestDeleteResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicSubmitMyAccountDeletionRequest.java'
example: |-
try {
final PublicSubmitMyAccountDeletionRequest operation = PublicSubmitMyAccountDeletionRequest.builder()
.build(
platformId,
platformToken,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsRequestDeleteResponse response = wrapper.publicSubmitMyAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'my'
- 'public'
- 'request'
- 'submit'
'PublicSubmitUserAccountDeletionRequest@jv.gdpr.fun':
id: 'PublicSubmitUserAccountDeletionRequest@jv.gdpr.fun'
name: 'PublicSubmitUserAccountDeletionRequest'
type: 'function'
description: |-
Submit user's account deletion request.
Requires valid user access token and password
Scope: account
### Request Header:
- **Content-Type: application/x-www-form-urlencoded**
arguments:
'languageTag':
type: 'String'
required: false
description: |-
Language tag
'namespace':
type: 'String'
required: true
description: |-
namespace of the user
'password':
type: 'String'
required: true
description: |-
IAM password of the user
'userId':
type: 'String'
required: true
description: |-
IAM ID of the user
return_type: 'ModelsRequestDeleteResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletion.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion/PublicSubmitUserAccountDeletionRequest.java'
example: |-
try {
final PublicSubmitUserAccountDeletionRequest operation = PublicSubmitUserAccountDeletionRequest.builder()
.languageTag(...)
.build(
namespace,
password,
userId,
);
final DataDeletion wrapper = new DataDeletion(sdk);
final ModelsRequestDeleteResponse response = wrapper.publicSubmitUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'public'
- 'request'
- 'submit'
- 'user'
'S2SGeneratePersonalDataURL@jv.gdpr.fun':
id: 'S2SGeneratePersonalDataURL@jv.gdpr.fun'
name: 'S2SGeneratePersonalDataURL'
type: 'function'
description: |-
Scope: account
Generate personal data download url.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
arguments:
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'requestDate':
type: 'String'
required: true
description: |-
Request date in RFC3339 format
'userId':
type: 'String'
required: true
description: |-
Publisher User Id
return_type: 'ModelsS2SUserDataURL'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrievalS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval_s2s/S2SGeneratePersonalDataURL.java'
example: |-
try {
final S2SGeneratePersonalDataURL operation = S2SGeneratePersonalDataURL.builder()
.build(
namespace,
requestDate,
userId,
);
final DataRetrievalS2S wrapper = new DataRetrievalS2S(sdk);
final ModelsS2SUserDataURL response = wrapper.s2sGeneratePersonalDataURL(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'generate'
- 'personal'
- 'retrieval'
- 's2s'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetDataRequestByRequestID@jv.gdpr.fun':
id: 'S2SGetDataRequestByRequestID@jv.gdpr.fun'
name: 'S2SGetDataRequestByRequestID'
type: 'function'
description: |-
Scope: account
Get Personal Data Request by Request Id.
If the request has been completed, it will return a download url for the data package.
---
## This API for S2S integration purpose only
arguments:
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'requestId':
type: 'String'
required: true
description: |-
Request Id
return_type: 'DtoS2SDataRequestSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrievalS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval_s2s/S2SGetDataRequestByRequestID.java'
example: |-
try {
final S2SGetDataRequestByRequestID operation = S2SGetDataRequestByRequestID.builder()
.build(
namespace,
requestId,
);
final DataRetrievalS2S wrapper = new DataRetrievalS2S(sdk);
final DtoS2SDataRequestSummary response = wrapper.s2sGetDataRequestByRequestID(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'by'
- 'data'
- 'get'
- 'id'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetListFinishedAccountDeletionRequest@jv.gdpr.fun':
id: 'S2SGetListFinishedAccountDeletionRequest@jv.gdpr.fun'
name: 'S2SGetListFinishedAccountDeletionRequest'
type: 'function'
description: |-
Scope: account
Get list of finished account deletion requests based on the finished time period.
Unfinished deletion requests will not appear here, i.e. have Status **Request**, **Pending** or **In-Progress**.
**Anonymize userId for deleted account:**
For user accounts that have been deleted, the **userId** field in this API will be anonymized automatically after **7 days** from the success deletion.
This measure is implemented to ensure compliance with GDPR regulations. Please make sure to synchronize the data from this API before it undergoes anonymization.
---
## This API for S2S integration purpose only
arguments:
'end':
type: 'String'
required: true
description: |-
Finished end time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Cannot exceed current time. End time is exclusive
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'start':
type: 'String'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
return_type: 'DtoListFinishedDataDeletion'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletionS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion_s2s/S2SGetListFinishedAccountDeletionRequest.java'
example: |-
try {
final S2SGetListFinishedAccountDeletionRequest operation = S2SGetListFinishedAccountDeletionRequest.builder()
.build(
end,
namespace,
start,
);
final DataDeletionS2S wrapper = new DataDeletionS2S(sdk);
final DtoListFinishedDataDeletion response = wrapper.s2sGetListFinishedAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'finished'
- 'get'
- 'list'
- 'request'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SGetListFinishedPersonalDataRequest@jv.gdpr.fun':
id: 'S2SGetListFinishedPersonalDataRequest@jv.gdpr.fun'
name: 'S2SGetListFinishedPersonalDataRequest'
type: 'function'
description: |-
Scope: account
Get list of finished personal data requests based on the finished time period.
Unfinished personal data requests will not appear here, i.e. have Status **Pending**, **In-Progress** or **Canceled**.
**Anonymize userId for deleted account:**
For user accounts that have been deleted, the **userId** field in this API will be anonymized automatically after **7 days** from the success deletion.
This measure is implemented to ensure compliance with GDPR regulations. Please make sure to synchronize the data from this API before it undergoes anonymization.
---
## This API for S2S integration purpose only
arguments:
'end':
type: 'String'
required: true
description: |-
Finished end time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Cannot exceed current time. End time is exclusive
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'start':
type: 'String'
required: true
description: |-
Finished start time (RFC3339 format, example: 2024-01-01T01:30:59.12Z). Start time is inclusive
return_type: 'DtoListFinishedDataRequests'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrievalS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval_s2s/S2SGetListFinishedPersonalDataRequest.java'
example: |-
try {
final S2SGetListFinishedPersonalDataRequest operation = S2SGetListFinishedPersonalDataRequest.builder()
.build(
end,
namespace,
start,
);
final DataRetrievalS2S wrapper = new DataRetrievalS2S(sdk);
final DtoListFinishedDataRequests response = wrapper.s2sGetListFinishedPersonalDataRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'finished'
- 'get'
- 'list'
- 'personal'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [READ]'
'S2SRequestDataRetrieval@jv.gdpr.fun':
id: 'S2SRequestDataRetrieval@jv.gdpr.fun'
name: 'S2SRequestDataRetrieval'
type: 'function'
description: |-
Scope: account
Submit user personal data retrieval request.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
**Notes:**
1. This API will **not send GDPR email notification** both for player and admin notification.
arguments:
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'userId':
type: 'String'
required: true
description: |-
Publisher User Id
return_type: 'ModelsS2SDataRetrievalResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_retrieval_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataRetrievalS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_retrieval_s2s/S2SRequestDataRetrieval.java'
example: |-
try {
final S2SRequestDataRetrieval operation = S2SRequestDataRetrieval.builder()
.build(
namespace,
userId,
);
final DataRetrievalS2S wrapper = new DataRetrievalS2S(sdk);
final ModelsS2SDataRetrievalResponse response = wrapper.s2sRequestDataRetrieval(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'data'
- 'request'
- 'retrieval'
- 's2s'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
'S2SSubmitUserAccountDeletionRequest@jv.gdpr.fun':
id: 'S2SSubmitUserAccountDeletionRequest@jv.gdpr.fun'
name: 'S2SSubmitUserAccountDeletionRequest'
type: 'function'
description: |-
Scope: account
Submit user's account deletion request.
**Limitation:** This API only accepts requests with a publisher userId and does not support game userId requests at this time.
---
## This API for S2S integration purpose only
**Notes:**
1. This API will **not send GDPR email notification** both for player and admin notification.
2. This API will **perform account deletion immediately** without GDPR grace period (i.e. 28 days grace period).
arguments:
'namespace':
type: 'String'
required: true
description: |-
Publisher Namespace
'userId':
type: 'String'
required: true
description: |-
Publisher User Id
return_type: 'ModelsS2SRequestDeleteResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.data_deletion_s2s.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/DataDeletionS2S.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/data_deletion_s2s/S2SSubmitUserAccountDeletionRequest.java'
example: |-
try {
final S2SSubmitUserAccountDeletionRequest operation = S2SSubmitUserAccountDeletionRequest.builder()
.build(
namespace,
userId,
);
final DataDeletionS2S wrapper = new DataDeletionS2S(sdk);
final ModelsS2SRequestDeleteResponse response = wrapper.s2sSubmitUserAccountDeletionRequest(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'account'
- 'data'
- 'deletion'
- 'request'
- 's2s'
- 'submit'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:S2S:INFORMATION:USER [CREATE]'
'SaveAdminEmailConfiguration@jv.gdpr.fun':
id: 'SaveAdminEmailConfiguration@jv.gdpr.fun'
name: 'SaveAdminEmailConfiguration'
type: 'function'
description: |-
Add admin email address for receiving personal data request notification.
Scope: account
arguments:
'body':
type: 'List<String>'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/SaveAdminEmailConfiguration.java'
example: |-
try {
final SaveAdminEmailConfiguration operation = SaveAdminEmailConfiguration.builder()
.build(
body,
namespace,
);
final Configuration wrapper = new Configuration(sdk);
wrapper.saveAdminEmailConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'email'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [CREATE]'
'UpdateAdminEmailConfiguration@jv.gdpr.fun':
id: 'UpdateAdminEmailConfiguration@jv.gdpr.fun'
name: 'UpdateAdminEmailConfiguration'
type: 'function'
description: |-
Update admin email address for receiving personal data request notification.
Scope: account
arguments:
'body':
type: 'List<String>'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.gdpr.models.*;'
- 'import net.accelbyte.sdk.api.gdpr.operations.configuration.*;'
- 'import net.accelbyte.sdk.api.gdpr.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/wrappers/Configuration.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/gdpr/operations/configuration/UpdateAdminEmailConfiguration.java'
example: |-
try {
final UpdateAdminEmailConfiguration operation = UpdateAdminEmailConfiguration.builder()
.build(
body,
namespace,
);
final Configuration wrapper = new Configuration(sdk);
wrapper.updateAdminEmailConfiguration(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'email'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:EMAIL:CONFIGURATION [UPDATE]'
# endregion functions
