Get the list of resources authorized by the role

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 resources authorized by the role through the role code in the permission group.

Method name

ManagementClient.getRoleAuthorizedResources

Request parameters

Name	Type	Required	Default value	Description	Sample value
code	string	yes	-	Unique identifier of the role in the permission group	60b49eb83fd80adb96f26e68
namespace	string	no	-	Code of the permission group	default
resourceType	string	no	-	Resource type, such as data, API, button, menu	DATA

Sample 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.getRoleAuthorizedResources({
    code: "60b49ebxxxxxxadb96f26e68",
    namespace: "default",
    resourceType: "DATA",
  });

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

Request response

Type: RoleAuthorizedResourcePaginatedRespDto

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

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "resourceCode": "ecs",
      "resourceType": "DATA",
      "actions": "[\"ecs:Start\",\"ecs:Stop\"]",
      "apiIdentifier": "dd8d7stf44"
    }
  }
}

Data structure

RoleAuthorizedResourcePagingDto

Name	Type	Required	Description	Sample value
totalCount	number	yes	total number of records
list	array	yes	data Nested type: <a RoleAuthorizedResourcesRespDto.

RoleAuthorizedResourcesRespDto

Name	Type	Required	Description	Sample value
resourceCode	string	Yes	Resource descriptor	ecs
resourceType	string	Yes	Resource type	DATA
actions	array	Yes	Authorized action list	["ecs:Start","ecs:Stop"]
apiIdentifier	string	Yes	API Identifier corresponding to the resource	dd8d7stf44