Single role batch authorization

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.

Assign roles through the role code in the permission group. The assignee can be a user or department.

Method name

ManagementClient.assignRole

Request parameters

Name	Type	Required	Default value	Description	Sample value
targets	<a TargetDto[]	Yes	-	Target object Array length limit: 50.	[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]
code	string	yes	-	Unique identifier of the role in the permission group	code1
endTime	number	no	-	Subject expiration time in milliseconds, valid forever if null	1669114748050
enableTime	number	no	-	Subject join time in milliseconds, join immediately if null	1669114748050
namespace	string	no	-	Code of the permission group	60b49eb83fd80adb96f26e68

Sample code

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

// Initialization 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.assignRole({
    code: "code1",
    namespace: "default",
    targets: [
      {
        targetType: Models.TargetDto.targetType.USER,
        targetIdentifier: "60b49eb83xxxxxxb96f26e68",
      },
    ],
  });

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

Request response

Type: IsSuccessRespDto

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, please see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a IsSuccessDto	Whether the operation is successful

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "success": true
  }
}

Data structure

TargetDto

Name	Type	Is it required	Description	Sample value
targetType	string	Yes	Target object type: - USER: User - ROLE: Role - GROUP: Group - DEPARTMENT: Department	USER
targetIdentifier	string	Yes	Unique identifier of the target object: - If it is a user, it is the user's ID, such as 6343b98b7cfxxx9366e9b7c - If it is a role, it is the role code, such as admin - If it is a group, it is the group code, such as developer - If it is a department, it is the department ID, such as 6343bafc019xxxx889206c4c	60b49eb83fd80adb96f26e68

IsSuccessDto

Name	Type	Is it required	Description	Example value
success	boolean	yes	Whether the operation was successful	true