¶ Array type resource authentication

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

Array type resource authentication supports users to determine the permissions of one or more array resources

¶ Method Name

AuthenticationClient.checkPermissionByArrayResource

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
resources	string[]	yes	-	Array data resource path list,	`["exampleArrayResource1","exampleArrayResource2"]`
action	string	yes	-	Data resource permission operation, read, get, write and other actions	`get`

¶ Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.BindEmailDto;
import cn.authing.sdk.java.dto.CheckPermissionArrayResourceDto;
import cn.authing.sdk.java.dto.CheckPermissionStringResourceDto;
import cn.authing.sdk.java.dto.CheckResourcePermissionsRespDto;
import cn.authing.sdk.java.dto.CommonResponseDto;
import cn.authing.sdk.java.dto.LoginTokenRespDto;
import cn.authing.sdk.java.dto.SignInOptionsDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
import java.util.ArrayList;

public class CheckPermissionArrayResourceTest {

    // Need to be replaced with your GenAuth App ID
    private static final String APP_ID = "AUTHING_APP_ID";
    // Need to be replaced with your GenAuth App Secret
    private static final String APP_SECRET = "AUTHING_APP_SECRET";
    // Need to be replaced with your GenAuth App Host
    private static final String APP_HOST = "AUTHING_APP_HOST";
    // Need to be replaced with your GenAuth Access Token
    private static final String ACCESS_TOKEN = "AUTHING_ACCESS_TOKEN";

    public static void main(String[] args) throws Throwable {

        AuthenticationClientOptions clientOptions = new AuthenticationClientOptions();
        clientOptions.setAppId(APP_ID);
        clientOptions.setAppSecret(APP_SECRET);
        clientOptions.setAppHost(APP_HOST);
        clientOptions.setAccessToken(ACCESS_TOKEN);

        AuthenticationClient client = new AuthenticationClient(clientOptions);

        CheckPermissionArrayResourceDto reqDto = new CheckPermissionArrayResourceDto();
        ArrayList<String> list = new ArrayList<>();
        list.add("arrayResourceCode");
        list.add("arrayResourceCode1");
        reqDto.setResources(list);
        reqDto.setAction("get");
        CheckResourcePermissionsRespDto checkResourcePermissionsRespDto = client
                .checkPermissionByArrayResource(reqDto);
        System.out.println(JsonUtils.serialize(checkResourcePermissionsRespDto));
    }
}

¶ Request Response

Type: CheckResourcePermissionsRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful requests are not returned). For a detailed list of error codes, see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	CheckResourcePermissionDataDto	Response data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "checkResultList": {
      "namespaceCode": "examplePermissionNamespace",
      "action": "get",
      "resource": "exampleResource",
      "enabled": true
    }
  }
}

¶ Data Structure

¶ CheckResourcePermissionDataDto

Name	Type	Is it required	Description	Example Value
checkResultList	array	yes	Check result list NestedType: CheckResourcePermissionRespDto.

¶ CheckResourcePermissionRespDto

Name	Type	Is it required	Description	Example Value
namespaceCode	string	yes	Permission space Code	`examplePermissionNamespace`
action	string	yes	Data resource permission operation	`get`
resource	string	yes	Resource path	`exampleResource`
enabled	boolean	yes	Whether the user has a certain operation of the data resource under a certain permission space	`true`

Previous article: String type resource authentication Next article: Tree type resource authentication