Search for the list of organizations

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If the description of this document is incorrect, please refer to the V3 API.

Search for the list of organizations by searching for keywords, and support paging.

Method name

ManagementClient.searchOrganizations

Request parameters

Name	Type	Is it required?	Default value	Description	Sample value
keywords	string	yes	-	Search keywords, such as organization name	GenAuth
page	number	no	1	Current page number, starting from 1	1
limit	number	no	10	Number per page, maximum cannot exceed 50, default is 10	10
withCustomData	boolean	no	-	Whether to obtain custom data	true
tenantId	string	No	-	Tenant ID	623c20b2a062aaaaf41b17da

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.searchOrganizations({
    keywords: "GenAuth",
    page: 1,
    limit: 10,
    withCustomData: true,
  });

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

Request response

Type: OrganizationPaginatedRespDto

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

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "organizationCode": "steamory",
      "organizationName": "Steam Memory",
      "description": "Organization description information",
      "createdAt": "2022-07-03T03:20:30.000Z",
      "updatedAt": "2022-07-03T03:20:30.000Z",
      "departmentId": "60b49eb83fd80adb96f26e68",
      "openDepartmentId": "60b49eb83fd80adb96f26e68",
      "hasChildren": true,
      "leaderUserIds": "[\"60b49eb83fd80adb96f26e68\"]",
      "membersCount": 150,
      "i18n": {
        "organizationName": {
          "zh-CN": { "enabled": false, "value": "Chinese" },
          "en-US": { "enabled": false, "value": "English" }
        }
      },
      "customData": { "icon": "https://example.com/logo" },
      "tenantId": "623c20b2a062aaaaf41b17da",
      "postIdList": "[\"xxx\"]",
      "status": "false",
      "allow": "[\"xxx\"]"
    }
  }
}

Data Structure### OrganizationPagingDto

Name	Type	Is it required?	Description	Example value
totalCount	number	Yes	Total number of records
list	array	Yes	Response data nested type: <a OrganizationDto.

OrganizationDto

Name	Type	Is it required?	Description	Example value
organizationCode	string	yes	organizationcode	steamory
organizationName	string	yes	organization name	steammemory
description	string	no	organization description	organization description
createdAt	string	no	creation time	2022-07-03T03:20: 30.000Z
updatedAt	string	no	modification time	2022-07-03T03:20:30.000Z
departmentId	string	yes	root node ID	60b49eb83fd80adb96f26e68
openDepartmentId	string	no	root node custom ID	60b49eb83fd80adb96f26e68
hasChildren	boolean	yes	contains child nodes	true
leaderUserIds	array	no	department head ID	["60b49eb83fd80adb96f26e68"]
membersCount	number	yes	number of department members	150
isVirtualNode	boolean	Yes	Is it a virtual department
i18n		No	Multi-language settings Nested type: <a OrganizationNameI18nDto.	{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}
customData	object	No	Extended field data of department	{"icon":"https://example.com/logo"}
tenantId	string	No	Tenant ID	623c20b2a062aaaaf41b17da
postIdList	array	No	Post id list	["xxx"]
status	string	No	Status	false
allow	string	No	Access restriction	["xxx"]

OrganizationNameI18nDto

Name	Type	Is it required	Description	Sample value
organizationName		Yes	Multi-language-supported field Nested type: <a LangObject.	{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}

LangObject

Name	Type	Is it required?	Description	Sample value
zh-CN		Yes	Multilingual Chinese content Nested type: <a LangUnit.	{"enabled":false,"value":"中文"}
en-US		Yes	Multilingual English content Nested type: <a LangUnit.	{"enabled":false,"value":"English"}
zh-TW		Yes	Multilingual Traditional Chinese content Nesting type: <a LangUnit.	{"enabled":false,"value":"繁體中文"}
ja-JP		Yes	Multilingual Japanese content Nesting type: <a LangUnit.	{"enabled":false,"value":"日本語"}

LangUnit

Name	Type	Is it required?	Description	Sample value
enabled	boolean	yes	Whether it is enabled. If enabled, and the console selects this language, the content will be displayed. (Default is off)
value	string	yes	Multilingual content