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

  7. Management module

  8. /

  9. Manage data resources and permissions

  10. /
  11. Get data resource list

Get data resource list

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.

Get the data resource list, you can specify the filter by data resource Name, data resource Code and the permission space Code list to which the data resource belongs.

Method Name

ManagementClient.listDataResources

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
pagenumberNo1Current page number, starting from 11
limitnumberNo10The maximum number of pages per page cannot exceed 50, and the default value is 1010
querystringNo-Keyword search, can be data resource Name or data resource CodeResource1
namespaceCodesstring[]No-The permission space to which the permission data belongs Code list Array length limit: 50.["examplePermissionNamespace1","examplePermissionNamespac2"]

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.ListDataResourcesDto;
import cn.authing.sdk.java.dto.ListDataResourcesPaginatedRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;


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

        ListDataResourcesDto request = new ListDataResourcesDto();
        request.setPage(1);
        request.setLimit(10);
        request.setNamespaceCodes("examplePermissionNamespace1,examplePermissionNamespace2");

        ListDataResourcesPaginatedRespDto response = client.listDataResources(request);
        System.out.println(JsonUtils.serialize(response));
    }

}

Request Response

Type： ListDataResourcesPaginatedRespDto

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.
dataDataResourcesPaginatedRespDtoResponse data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "resourceName": "Sample data resource Name",
      "resourceCode": "dataResourceTestCode",
      "type": "TREE",
      "description": "Sample Data Resource Description",
      "namespaceCode": "examplePermissionNamespace",
      "namespaceName": "Example Permission Space",
      "authorizationNum": 1,
      "updatedAt": "2022-07-03T03:20:30.000Z"
    }
  }
}

Data Structure

DataResourcesPaginatedRespDto

NameType
Is it required
Description
Example Value
totalCountnumberyesTotal number of records
listarrayyesResponse data nested type：ListDataResourcesRespDto。

ListDataResourcesRespDto

NameType
Is it required
Description
Example Value
resourceNamestringyesData resource Name, unique in the permission spaceSample data resource Name
resourceCodestringyesData resource Code, unique in the permission spacedataResourceTestCode
typestringyesData resource type, currently supports tree structure (TREE), string (STRING), array (ARRAY)TREE
descriptionstringnoData resource descriptionSample Data Resource Description
namespaceCodestringyesThe permission space Code to which the data resource belongsexamplePermissionNamespace
namespaceNamestringyesThe permission space Name to which the data resource belongsSample Permission Space
authorizationNumnumberyesThe number of authorizations associated with the data resource1
updatedAtstringyesThe time when the data resource was updated2022-07-03T03:20:30.000Z