Create a string data 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 document description is incorrect, please refer to the V3 API.

When you only need to create a string type data resource, you can use this API. We have fixed the data resource type, and you do not need to pass in the type character field. Note: The struct field can only pass in string type data.

Method name

ManagementClient.createDataResourceByString

Request parameters

Name	Type	Required	Default value	Description	Sample value
actions	string[]	Yes	-	Data resource permission operation list Array length limit: 50.	["read","get"]
struct	string	yes	-	String data resource node	exampleStringStruct
resourceCode	string	yes	-	Data resource Code, unique in the permission space	dataResourceTestCode
resourceName	string	yes	-	Data resource name, unique in the permission space	Sample data resource name
namespaceCode	string	yes	-	Permission space where the data policy is located	code1
description	string	no	-	Data resource description	Sample data resource description

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 you are a privately deployed customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.createDataResourceByString({
    namespaceCode: "examplePermissionNamespace",
    resourceCode: "stringResourceCode",
    resourceName: "Example string data resource",
    struct: "exampleStringStruct",
    description: "Example string data resource description",
    actions: ["get", "read"],
  });

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

Request response

Type: CreateStringDataResourceResponseDto

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 requests are not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. This will be returned when the request fails.
data	<a CreateStringDataResourceRespDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "resourceName": "Sample data resource name",
    "resourceCode": "dataResourceTestCode",
    "type": "TREE",
    "description": "Sample data resource description",
    "struct": "exampleStringStruct",
    "actions": "[\"read\",\"get\"]"
  }
}

Data structure

CreateStringDataResourceRespDto

Name	Type	Is it required	Description	Example value
resourceName	string	yes	Data resource name, unique in the permission space	Example data resource name
resourceCode	string	yes	Data resource Code, unique in the permission space	dataResourceTestCode
type	string	yes	Data resource type, currently supports tree structure (TREE), string (STRING), array (ARRAY)	TREE
description	string	no	Data resource description	Example data resource description
struct	string	yes	String data resource node	exampleStringStruct
actions	array	yes	Data resource permission operation list Array length limit: 50.	["read","get"]