1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. Management module

  8. /

  9. Manage data resources and permissions

  10. /
  11. Modify data policy

Modify data policy

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Modify data policy, modify data policy information through fields such as data policy Name, data policy description, and related data resources.

Method Name

ManagementClient.updateDataPolicy

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
policyIdstringyes-Data Policy ID60b49xxxxxxxxxxxxxxx6e68
policyNamestringno-Data policy name, unique to the user poolExample Data Policy Name
descriptionstringno-Data policy descriptionExample Data Policy Description
statementListDataStatementPermissionDto[]No-Data permission list, all data permissions under each policy. Array length limit: 5.

Sample Code

package test.management.dataPermission.policy;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.DataStatementPermissionDto;
import cn.authing.sdk.java.dto.UpdateDataPolicyDto;
import cn.authing.sdk.java.dto.UpdateDataPolicyResponseDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

import java.util.ArrayList;
import java.util.List;

public class UpdateDataPolicyTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");
        ManagementClient client = new ManagementClient(clientOptions);

        UpdateDataPolicyDto reqDto = new UpdateDataPolicyDto();
        reqDto.setPolicyId("60b49xxxxxxxxxxxxxxx6e68");
        reqDto.setPolicyName("Sample Data Policy Name");
        List<DataStatementPermissionDto> list = new ArrayList<>();
        DataStatementPermissionDto permissionDto = new DataStatementPermissionDto();
        List<String> list1 = new ArrayList<>();
        list1.add("namespaceCode/treeResourceCode/path/action");
        permissionDto.setPermissions(list1);
        permissionDto.setEffect(DataStatementPermissionDto.Effect.ALLOW);
        list.add(permissionDto);
        reqDto.setStatementList(list);
        reqDto.setDescription("Sample Data Policy Description");
        UpdateDataPolicyResponseDto response = client.updateDataPolicy(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type： UpdateDataPolicyResponseDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataUpdateDataPolicyRespDtoResponse data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "policyId": "60b49xxxxxxxxxxxxxxx6e68",
    "policyName": "Sample Data Policy Name",
    "description": "Sample Data Policy Description",
    "createdAt": "2022-07-03T03:20:30.000Z",
    "updatedAt": "2022-07-03T03:20:30.000Z"
  }
}

Data Structure

DataStatementPermissionDto

NameType
Is it required
Description
Example Value
effectstringyesData resource permission operation: ALLOW (allow)/DENY (deny)DENY
permissionsarrayyesResource permission list, string data resource and array data resource, no path path["namespaceCode/stringResourceCode/action","namespaceCode/arrayResourceCode/action","namespaceCode/treeResourceCode/path/action"]

UpdateDataPolicyRespDto

NameType
Is it required
Description
Example Value
policyIdstringyesData Policy ID60b49xxxxxxxxxxxxxxx6e68
policyNamestringyesData policy name, unique to the user poolSample data policy name
descriptionstringNoData policy descriptionSample data policy description
createdAtstringyesData policy creation time2022-07-03T03:20:30.000Z
updatedAtstringyesData policy update time2022-07-03T03:20:30.000Z