Get the department list of the role

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

Get the department list of the role through the role code in the permission group, supporting paging.

Method name

ManagementClient.listRoleDepartments

Request parameters

Name	Type	Required	Default value	Description	Sample value
code	string	yes	-	Unique identifier of the role in the permission group	manager
namespace	string	no	-	Code of the permission group	default
page	number	no	1	Current page number, starting from 1	1
limit	number	no	10	Number of pages per page, maximum cannot exceed 50, default is 10	10

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.listRoleDepartments({
    code: "manager",
    namespace: "default",
    page: 1,
    limit: 10,
  });

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

Request response

Type: RoleDepartmentListPaginatedRespDto

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 RoleDepartmentListPagingDto	data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "id": "60b49eb83fd80adb96f26e68",
      "code": "code",
      "name": "departmentName",
      "description": "dd8d7stf44"
    }
  }
}

Data structure

RoleDepartmentListPagingDto

Name	Type	Is it required?	Description	Example value
totalCount	number	yes	total number of records
list	array	yes	data Nested type: <a RoleDepartmentRespDto.

RoleDepartmentRespDto

Name	Type	Required	Description	Sample value
id	string	Yes	Department ID	60b49eb83fd80adb96f26e68
code	string	Yes	Department code	code
name	string	Yes	Department name	departmentName
description	string	Yes	Department description	dd8d7stf44