¶ Get data resource details

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

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 document description is incorrect, please refer to V3 API.

Get data resources, query the corresponding data resource information through the data resource ID, including data resource Name, data resource Code, data resource type (TREE, STRING, ARRAY), data resource permission space ID, data resource permission space Code, and data resource operation list and other basic information.

¶ Method Name

ManagementClient.getDataResource

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
resourceCode	string	yes	-	Data resource Code, unique in the permission space	`dataResourceTestCode`
namespaceCode	string	yes	-	Permission space to which the data resource belongs	`examplePermissionNamespace`

¶ Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.GetDataResourceDto;
import cn.authing.sdk.java.dto.GetDataResourceResponseDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;


public class GetDataResourceTest {
    // 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);

        GetDataResourceDto request = new GetDataResourceDto();
        request.setNamespaceCode("examplePermissionNamespace");
        request.setResourceCode("resourceCode");

        GetDataResourceResponseDto response = client.getDataResource(request);
        System.out.println(JsonUtils.serialize(response));
    }

}

¶ Request Response

Type： GetDataResourceResponseDto

Name	Type	Description
statusCode	number	Business status code. You can use this status code to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segment 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)
requestId	string	Request ID. Returned when the request fails.
data	GetDataResourceRespDto	Response data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "resourceName": "Sample data resource Name",
    "resourceCode": "dataResourceTestCode",
    "type": "TREE",
    "description": "Sample Data Resource Description",
    "namespaceCode": "code1",
    "actions": "[\"read\",\"get\"]"
  }
}

¶ Data Structure

¶ GetDataResourceRespDto

Name	Type	Is it required	Description	Example Value
resourceName	string	yes	Data resource Name, unique in the permission space	`Sample data resource Name`
resourceCode	string	yes	Data resource Code, unique in the permission space	`dataResourceTestCode`
type	string	yes	Data resource type, currently supports tree structure (TREE), string (STRING), array (ARRAY)	TREE
description	string	no	Data resource description	`Sample Data Resource Description`
struct	yes	Data resource structure, supports string (STRING), tree structure (TREE) and array structure (ARRAY).
namespaceCode	string	yes	Permission space where the data policy is located	`code1`
actions	array	yes	Data resource permission operation list Array length limit: 50.	`["read","get"]`
extendFieldList	Dnef[]	No	Data resource extension field (currently only supports tree type resources)

¶ Dnef

Name	Type	Is it required	Description	Example Value
key	string	yes	Extended field Key	`str`
valueType	ValueType	yes	Extended field value type	`STRING` (text), `SELECT` (single choice)
label	string	yes	Extended field display Name	`str_label`
config	DnefConfig	No	Field configuration, single-select type fields must be passed

¶ DnefConfig

Name	Type	Is it required	Description	Example Value
options	Option[]	yes	Single-select type field option list

¶ Option

Name	Type	Is it required	Description	Example Value
value	string	yes	option value	`option1`

Previous article: Get data resource list Next article: Modify data resources