Create a permission space

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 a permission space, you can set the permission space name, code and description information.

Method name

ManagementClient.createPermissionNamespace

Request parameters

Name	Type	Required	Default value	Description	Example value
name	string	Yes	-	Permission space name	Example permission space
code	string	Yes	-	Permission space Code	examplePermissionNamespace
description	string	No	-	Permission space description	Example permission space description

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.createPermissionNamespace({
    code: "examplePermissionNamespace",
    name: "Example Permission Space",
    description: "Example Permission Space Description",
  });

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

Request Response

Type: CreatePermissionNamespaceResponseDto

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 is returned when the request fails.
data	<a CreatePermissionNamespaceRespDto	Response data

Example result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "code": "examplePermissionNamespace",
    "name": "Example Permission Space",
    "description": "Example Permission Space Description"
  }
}

Data structure

CreatePermissionNamespaceRespDto

Name	Type	Is it required?	Description	Example value
code	string	yes	permission space unique identifier	examplePermissionNamespace
name	string	yes	permission space name	example permission space
description	string	no	permission space description	example permission space description