Get the list of resources authorized by the user in the logged-in application

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 list of resource permissions specified by the user. The user obtains the list of resources owned by the user in a certain application.

Method name

AuthenticationClient.getUserAuthorizedResourcesList

Request parameters

Name	Type	Required	Default value	Description	Sample value

Sample code

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

const authenticationClient = new AuthenticationClient({
  // Need to replace with your GenAuth AppId, Secret and Host
  appId: "GEN_AUTH_APP_ID",
  appSecret: "GEN_AUTH_APP_SECRET",
  appHost: "GEN_AUTH_APP_HOST",
});

(async () => {
  // Please call the login interface to get access_token first, and call the setAccessToken method to set access_token
  authenticationClient.setAccessToken("REPLACE_ME_WITH_REAL_ACCESS_TOKEN");

  const result = await authenticationClient.getUserAuthorizedResourcesList();

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

Request response

Type: GetUserAuthResourceListRespDto

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 request is not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a GetUserAuthResourceListDataDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "userPermissionList": {
      "userId": "6301cexxxxxxxxxxxxxxxxx78",
      "namespaceCode": "examplePermissionNamespace",
      "resourceList": {
        "resourceCode": "resourceCode",
        "resourceType": "STRING",
        "strAuthorize": {
          "value": "Sample string resource Value",
          "actions": "[\"read\",\"get\"]"
        },
        "arrAuthorize": {
          "values": "[\"value0\",\"value1\"]",
          "actions": "[\"read\",\"get\"]"
        },
        "treeAuthorize": {
          "authList": {
            "nodePath": "/treeCode1/treeCode11",
            "nodeName": "Sample tree resource node name",
            "nodeActions": "[\"read\",\"get\"]",
            "nodeValue": "Sample tree resource node Value"
          }
        }
      }
    }
  }
}

Data structure

GetUserAuthResourceListDataDto

Name	Type	Is it required	Description	Sample value
userPermissionList	array	Yes	User permission list Nested type: <a UserAuthResourceListDto.

UserAuthResourceListDto

Name	Type	Is it required?	Description	Example value
userId	string	Yes	User ID authorized by data policy	6301cexxxxxxxxxxxxxxxxx78
namespaceCode	string	Yes	Permission space authorized by data policy Code	examplePermissionNamespace
resourceList	array	No	List of all data policy resources of the user under the permission space Nested type: <a OpenResource.

OpenResource

Name	Type	Is it required?	Description	Sample value
resourceCode	string	Yes	Data resource Code authorized under the data policy	resourceCode
resourceType	string	Yes	Data resource type authorized under the data policy. Currently, it supports three types: tree structure (TREE), string (STRING), and array (ARRAY). Different structures are returned according to different types. - STRING: string type result StrAuthorize - ARRAY: array type ArrayAuthorize - TREE: tree type TreeAuthorize	TREE
strAuthorize		No	String resource of data policy Nested type: <a StrAuthorize.
arrAuthorize		No	Array resource of data policy Nested type: <a ArrayAuthorize.
treeAuthorize		No	Tree resource of data policy Nested type: <a TreeAuthorize.

StrAuthorize

Name	Type	Is it required?	Description	Sample value
value	string	Yes	String resource Value	Sample string resource Value
actions	array	Yes	String resource action list	["read","get"]

ArrayAuthorize

Name	Type	Is it required?	Description	Sample value
values	array	Yes	Array resource Value list	["value0","value1"]
actions	array	Yes	Array resource action list	["read","get"]

TreeAuthorize

| Name | Type | Is it required | Description | Sample value | |