Get the role list

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 the V3 API.

Get role list

Method name

AuthenticationClient.getRoleList

Request parameters

Name	Type	Required	Default value	Description	Sample value
namespace	string	No	-	Code of the permission group (permission space). If not passed, the default permission group is obtained.	default

Sample code

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

const authenticationClient = new AuthenticationClient({
  // Need to be replaced 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.getRoleList({
    namespace: "default",
  });

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

Request response

Type: RoleListRespDto

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	array	response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "id": "60b49eb83fd80adb96f26e68",
    "code": "role1",
    "name": "role1",
    "description": "this is role description",
    "namespace": "default",
    "namespaceName": "Sample permission name",
    "status": "ENABLE",
    "disableTime": "1669881887852"
  }
}

Data structure

RoleDto

Name	Type	Is it required?	Description	Sample value
id	string	Yes	Role ID	60b49eb83fd80adb96f26e68
code	string	Yes	Unique identifier of the role in the permission group (permission space) Code	role1
name	string	Yes	Role name in the permission group (permission space)	role1
description	string	Yes	Role description	this is role description
namespace	string	Yes	Code of the permission group (permission space). If not passed, the default permission group is obtained.	default
namespaceName	string	yes	The name of the permission group (permission space)	Sample permission name
status	string	No	Role status, ENABLE- means normal, DISABLE- means disabled	ENABLE
disableTime	number	No	Role automatic disable time, in milliseconds, if null is passed, it means permanent	1669881887852