Determine whether the user has permission to perform a certain operation on a certain resource

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.

Determine whether the user has permission to perform a certain operation on a certain resource.

Method name

ManagementClient.isActionAllowed

Request parameters

Name	Type	Required	Default value	Description	Sample value
resource	string	Yes	-	Resource identifier	ecs:1
action	string	Yes	-	Action corresponding to the resource	ecs:Start
userId	string	Yes	-	User ID	userId1
namespace	string	No	-	Code of the permission group (permission space). Do not pass to obtain the default permission group.	default

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.isActionAllowed({
    namespace: "default",
    userId: "userId1",
    resource: "ecs:1",
    action: "ecs:Start",
  });

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

Request response

Type: IsActionAllowedRespDtp

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 IsActionAllowedDataDto	Response data

Sample result:

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

Data structure

IsActionAllowedDataDto

| Name | Type | Is it required | Description | Sample value | | ------- | ------- | ----------------------------------------------- | ---------------------------------- | ----------------------------------------------- | |allowed | boolean | yes | allowed | true |