Create resources

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.

Create resources, you can set the description of the resource, the defined operation type, URL identifier, etc.

Method name

ManagementClient.createResource

Request parameters

Name	Type	Required	Default value	Description	Sample value
type	string	yes	-	Resource type, such as data, API, button, menu	API
code	string	yes	-	Resource unique identifier	ecs
description	string	no	-	Resource description	Server
name	string	no	-	Resource name	Server
actions	<a ResourceAction[]	No	-	Operation type defined by the resource. Array length limit: 100.	[{"name":"ecs:Start","description":"Start ECS server"},{"name":"ecs:Stop","description":"Stop ECS server"}]
apiIdentifier	string	No	-	URL identifier of the API resource	https://my-awesome-api.com/api
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.createResource({
    code: "ecs",
    description: "Server",
    type: Models.ResourceDto.type.API,
    actions: [
      {
        name: "ecs:Start",
        description: "ecs:Start",
      },
    ],
    apiIdentifier: "https://my-awesome-api.com/api",
    namespace: "default",
  });

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

Request response

Type: ResourceRespDto

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 information
apiCode	number	Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a ResourceDto	Resource details

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "code": "ecs",
    "description": "Server",
    "name": "Server",
    "type": "API",
    "actions": "[{\"name\":\"ecs:Start\",\"description\":\"Start ECS server\"},{\"name\":\"ecs:Stop\",\"description\":\"Stop ECS server\"}]",
    "apiIdentifier": "https://my-awesome-api.com/api",
    "namespace": "default"
  }
}

Data structure

ResourceAction

Name	Type	Is it required?	Description	Sample value
name	string	Yes	Resource operation name	ecs:Start
description	string	Yes	Resource operation description	ecs:Start

ResourceDto

Name	Type	Is it required?	Description	Sample value
code	string	yes	Resource unique identifier	ecs
description	string	no	Resource description	Server
name	string	no	Resource name	Server
type	string	yes	Resource type, such as data, API, button, menu	DATA
actions	array	no	Action types defined by the resource Nested type: <a ResourceAction. Array length limit: 100.	[{"name":"ecs:Start","description":"Start ECS server"},{"name":"ecs:Stop","description":"Stop ECS server"}]
apiIdentifier	string	No	URL identifier of API resource	https://my-awesome-api.com/api
namespace	string	No	Code of the permission group (permission space). Do not pass to obtain the default permission group.	default
linkedToTenant	boolean	No	Whether the tenant application is associated with the self-built application resources

ResourceAction

Name	Type	Is it required	Description	Sample value
name	string	yes	Resource operation name	ecs:Start
description	string	yes	Resource operation description	ecs:Start