Determine the user's permissions at the same level of a tree resource (recommended)

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If the document description is incorrect, please refer to the V3 API.

Description

This interface is used to determine whether the user has certain permissions on the nodes of the same level of a tree resource. Since tree-type resources are more commonly used, we have added an interface for determining the permissions of tree-type resource nodes based on the business scenario of "determining whether the user has resource permissions".

Note

We use the resource parameter to locate a certain level of the tree type data resource (so the parameter is passed in the format of resource code/node code path), and use the resourceNodeCodes parameter to locate the current nodes.

Scenario Example

If your business scenario is: when a user deletes certain files in a folder in a file system, you need to determine whether he has the permission to delete these files, then you can use this interface.

Request example

Example of judging the user's permissions at the same level of tree resources (unconditional judgment)

{
  "namespaceCode": "examplePermissionNamespace",
  "userId": "63721xxxxxxxxxxxxdde14a3",
  "action": "read",
  "resource": "treeResourceCode/structCode",
  "resourceNodeCodes": [
    "resourceStructChildrenCode1",
    "resourceStructChildrenCode2",
    "resourceStructChildrenCode3"
  ]
}

Example of judging the user's permissions at the same level of tree resources (enable conditional judgment)

{
  "namespaceCode": "examplePermissionNamespace",
  "userId": "63721xxxxxxxxxxxxdde14a3",
  "action": "read",
  "resource": "treeResourceCode/structCode",
  "resourceNodeCodes": [
    "resourceStructChildrenCode1",
    "resourceStructChildrenCode2",
    "resourceStructChildrenCode3"
  ],
  "judgeConditionEnabled": true,
  "authEnvParams": {
    "ip": "110.96.0.0",
    "city": "Beijing",
    "province": "Beijing",
    "country": "China",
    "deviceType": "PC",
    "systemType": "ios",
    "browserType": "IE",
    "requestDate": "2022-12-26 17:40:00"
  }
}

Method name

ManagementClient.checkUserSameLevelPermission

Request parameters

Name	Type	Required	Default value	Description	Sample value
resourceNodeCodes	string[]	yes	-	Current tree resource path child node Code	["resourceStructChildrenCode1"]
resource	string	yes	-	Tree resource path, multi-level paths are allowed, the example is as follows - treeResourceCode - treeResourceCode/structCode - treeResourceCode/structCode/struct1Code - treeResourceCode/.../structCode	treeResourceCode
action	string	yes	-	Data resource permission operation	read
userId	string	yes	-	User ID	63721xxxxxxxxxxxxdde14a3
namespaceCode	string	yes	-	Permission space Code	examplePermissionNamespace
judgeConditionEnabled	boolean	no	-	Whether to enable conditional judgment, the default is false and not enabled
authEnvParams	<a AuthEnvParams	no	-	Conditional environment attribute, if conditional judgment is enabled, use	{"ip":"127.0.0.1"}

Example code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.checkUserSameLevelPermission({
    namespaceCode: "examplePermissionNamespace",
    userId: "63721xxxxxxxxxxxxdde14a3",
    action: "get",
    resource: "strResourceCode",
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request Response

Type: CheckUserSameLevelPermissionResponseDto

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
requestId	string	Request ID. It will be returned when the request fails.
data	<a CheckUserSameLevelPermissionDataDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "checkLevelResultList": {
      "action": "get",
      "resourceNodeCode": "treeResourceStructChildrenCode1",
      "enabled": true
    }
  }
}

Data structure

AuthEnvParams

Name	Type	Is it required?	Description	Sample value
ip	string	no	ip	127.0.0.1
city	string	no	city	Beijing
province	string	no	province	Hubei
country	string	no	country	China
deviceType	string	no	device type: PC/Mobile	PC
systemType	string	no	operation type: Windows, Android, iOS, MacOS	Windows
browserType	string	no	browser type: IE/Chrome/Firefox	IE
requestDate	string	no	request time	2022-07-03T03:20:30.000Z

CheckUserSameLevelPermissionDataDto

Name	Type	Is it required	Description	Sample value
checkLevelResultList	array	Yes	Response result list Nested type: <a CheckUserSameLevelPermissionRespDto.

CheckUserSameLevelPermissionRespDto

Name	Type	Is it required	Description	Sample value
action	string	Yes	Data resource permission operation	get
resourceNodeCode	string	yes	tree resource node code	treeResourceStructChildrenCode1
enabled	boolean	yes	whether it has action permission	true