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

  7. Management module

  8. /

  9. Manage data resources and permissions

  10. /
  11. Check whether the permission space Code or name is available

Verify whether the permission space 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 whether it is available through user pool ID and permission space Code, or user pool ID and permission space Name.

Method Name

ManagementClient.checkPermissionNamespaceExists

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
codestringNo-Permission space CodeexamplePermissionNamespace
namestringNo-Permission space NameExample Permission Space

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CheckPermissionNamespaceExistsDto;
import cn.authing.sdk.java.dto.PermissionNamespaceCheckExistsRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;


public class CheckPermissionNamespaceExistsTest {

    // 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);

        CheckPermissionNamespaceExistsDto request1 = new CheckPermissionNamespaceExistsDto();
        request1.setName("Example permission space Name");
        PermissionNamespaceCheckExistsRespDto response1 = client.checkPermissionNamespaceExists(request1);
        System.out.println(JsonUtils.serialize(response1));
        CheckPermissionNamespaceExistsDto request2 = new CheckPermissionNamespaceExistsDto();
        request2.setCode("examplePermissionNamespace");
        PermissionNamespaceCheckExistsRespDto response2 = client.checkPermissionNamespaceExists(request2);
        System.out.println(JsonUtils.serialize(response2));
    }

}

Request Response

Type： PermissionNamespaceCheckExistsRespDto

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

Example Results：

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

Data Structure

CheckPermissionNamespaceExistsRespDto

NameType
Is it required
Description
Example Value
isValidbooleanyesCheck whether the permission space Name or permission space Name Code is validfalse
messagestringnoPrompt message if the permission space Name or permission space Code verification fails. If the verification succeeds, Message is not returnedpermission namespace code already exist