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

  7. Management module

  8. /

  9. Manage data resources and permissions

  10. /
  11. Check data resource name or Code Is it available

Check if the data resource Code or Name is available

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.

Check if the data resource Name or Code is valid in the permission space. Use the data resource Name or data resource Code and the permission space Code to determine whether it is available in the specified permission space.

Data resource Code valid example

  • Entry
{
  "namespaceCode": "examplePermissionNamespace",
  "resourceCode": "test"
}
  • Parameters
{
  "statusCode": 200,
  "message": "Operation successful",
  "apiCode": 0,
  "data": {
    "isValid": "true"
  }
}

Valid examples of data resource Name

  • Entry
{
  "namespaceCode": "examplePermissionNamespace",
  "resourceName": "test"
}
  • Parameters
{
  "statusCode": 200,
  "message": "Operation successful",
  "apiCode": 0,
  "data": {
    "isValid": "true"
  }
}

Data resource Code Invalid example

  • Entry
{
  "namespaceCode": "examplePermissionNamespace",
  "resourceCode": "test"
}
  • Parameters
{
  "statusCode": 200,
  "message": "Operation successful",
  "apiCode": 0,
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "isValid": "false",
    "message": "data resource code already exist"
  }
}

Method Name

ManagementClient.checkDataResourceExists

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
namespaceCodestringyes-The permission space Code to which the data resource belongsexamplePermissionNamespace
resourceNamestringno-Data resource Name, unique in the permission spaceExample data resource Name
resourceCodestringno-Data resource Code, unique in the permission spacedataResourceTestCode

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CheckDataResourceExistsDto;
import cn.authing.sdk.java.dto.CheckParamsDataResourceResponseDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;


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

        CheckDataResourceExistsDto request = new CheckDataResourceExistsDto();
        request.setNamespaceCode("examplePermissionNamespace");
        request.setResourceName("Example tree data resource Name");

        CheckParamsDataResourceResponseDto response1 = client.checkDataResourceExists(request);
        System.out.println(JsonUtils.serialize(response1));

        request.setNamespaceCode("examplePermissionNamespace");
        request.setResourceCode("treeResourceCode");

        CheckParamsDataResourceResponseDto response2 = client.checkDataResourceExists(request);
        System.out.println(JsonUtils.serialize(response2));
    }

}

Request Response

Type： CheckParamsDataResourceResponseDto

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

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "isValid": "false",
    "message": "data resource name already exist"
  }
}

Data Structure

CheckParamsDataResourceRespDto

NameType
Is it required
Description
Example Value
isValidbooleanYesIs the data resource Name or Code verification valid?false
messagestringNoPrompt message if the data resource Name or Code verification fails. If the verification succeeds, message is not returned.data resource name already exist