diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 80839c493..9e0fd3bc0 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -14,19 +14,19 @@ const head = [ rel: "icon", type: "image/png", sizes: "32x32", - href: "https://authing.cn/favicon.ico" - } + href: "https://authing.cn/favicon.ico", + }, ], [ "script", {}, - `!function(){var e=window.Cohere=window.Cohere||[];if(e.invoked)console.error("Tried to load Cohere twice");else{e.invoked=!0,e.snippet="0.2",e.methods=["init","identify","stop","showCode","getSessionUrl","makeCall","addCallStatusListener","removeCallStatusListener","widget","addSessionUrlListener","removeSessionUrlListener",],e.methods.forEach(function(o){e[o]=function(){var t=Array.prototype.slice.call(arguments);t.unshift(o),e.push(t)}});var o=document.createElement("script");o.type="text/javascript",o.async=!0,o.src="https://static.cohere.so/main.js",o.crossOrigin="anonymous";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(o,t)}}();` + `!function(){var e=window.Cohere=window.Cohere||[];if(e.invoked)console.error("Tried to load Cohere twice");else{e.invoked=!0,e.snippet="0.2",e.methods=["init","identify","stop","showCode","getSessionUrl","makeCall","addCallStatusListener","removeCallStatusListener","widget","addSessionUrlListener","removeSessionUrlListener",],e.methods.forEach(function(o){e[o]=function(){var t=Array.prototype.slice.call(arguments);t.unshift(o),e.push(t)}});var o=document.createElement("script");o.type="text/javascript",o.async=!0,o.src="https://static.cohere.so/main.js",o.crossOrigin="anonymous";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(o,t)}}();`, ], [ "script", {}, - `if(window.location.hostname === "docs.authing.cn"){window.Cohere.init("PUkf845sOZgDd59V6aTJCsuJ");}` - ] + `if(window.location.hostname === "docs.authing.cn"){window.Cohere.init("PUkf845sOZgDd59V6aTJCsuJ");}`, + ], ]; if (gaEnabled) { @@ -34,8 +34,8 @@ if (gaEnabled) { "script", { async: true, - src: `https://www.googletagmanager.com/gtag/js?id=${gTrackingId}` - } + src: `https://www.googletagmanager.com/gtag/js?id=${gTrackingId}`, + }, ]); head.push([ "script", @@ -44,7 +44,7 @@ if (gaEnabled) { function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); - gtag('config', '${gTrackingId}');` + gtag('config', '${gTrackingId}');`, ]); } @@ -59,16 +59,16 @@ module.exports = { markdown: { // lineNumbers: true, anchor: { - permalinkSymbol: "¶" + permalinkSymbol: "¶", }, toc: { - includeLevel: [2, 3, 4, 5] + includeLevel: [2, 3, 4, 5], }, extractHeaders: ["h2", "h3", "h4", "h5"], - extendMarkdown: md => { + extendMarkdown: (md) => { // 使用更多的 markdown-it 插件! md.use(require("markdown-it-include"), "docs"); - } + }, }, locales: { // The key is the path for the locale to be nested under. @@ -88,7 +88,7 @@ module.exports = { back: "回到列表", next: "下一步", previous: "上一步", - lastStep: "我知道了,返回列表" + lastStep: "我知道了,返回列表", }, "/en/": { lang: "en-US", @@ -105,13 +105,12 @@ module.exports = { back: "Back to list", next: "Next", previous: "Previous", - lastStep: "I know, return to the list" - } + lastStep: "I know, return to the list", + }, }, head, themeConfig: { - logo: - "https://files.authing.co/authing-console/authing-logo-new-20210924.svg", + logo: "https://files.authing.co/authing-console/authing-logo-new-20210924.svg", officeSiteDomain: "authing.cn", officeSiteUrl: "https://authing.cn", consoleDomain: "https://console.authing.cn", @@ -137,6 +136,13 @@ module.exports = { search: "搜索标题", searchInDoc: "在文档中搜索", oldVersion: "旧版", + share: { + share: "分享", + copyLink: "复制链接", + weibo: "新浪微博", + wechat: "微信扫一扫", + copied: "链接已复制", + }, nav: [ { text: "快速开始", link: "/quickstarts/" }, { text: "概念", link: "/concepts/" }, @@ -144,16 +150,16 @@ module.exports = { { text: "开发集成", link: "/reference/" }, { text: "应用集成", - link: "/integration/" + link: "/integration/", }, { text: "加入 APN", - link: "/apn/" + link: "/apn/", }, { link: "/reference-new/", text: "开发集成", - hidden: true + hidden: true, }, { link: "/tenant/", @@ -180,32 +186,32 @@ module.exports = { reasons: [ { value: "内容错误", - label: "内容错误" + label: "内容错误", }, { value: "缺少代码/图片示例", - label: "缺少代码/图片示例" + label: "缺少代码/图片示例", }, { value: "更新不及时", - label: "更新不及时" + label: "更新不及时", }, { value: "太简单/步骤待完善", - label: "太简单/步骤待完善" + label: "太简单/步骤待完善", }, { value: "链接错误", - label: "链接错误" + label: "链接错误", }, { value: "其他", - label: "其他" - } + label: "其他", + }, ], customReasonPlaceholder: - "请详细描述在文档使用中遇到的问题或改进建议(选填)" - } + "请详细描述在文档使用中遇到的问题或改进建议(选填)", + }, }, footer: { sections: [ @@ -214,81 +220,81 @@ module.exports = { links: [ { text: "集成第三方登录", - link: "/guides/connections/" + link: "/guides/connections/", }, { text: "手机号闪验", - link: "https://authing.cn/verify" + link: "https://authing.cn/verify", }, { text: "通用登录表单组件", - link: "/reference/ui-components/" + link: "/reference/ui-components/", }, { text: "自定义认证流程", - link: "/guides/pipeline/" - } - ] + link: "/guides/pipeline/", + }, + ], }, { title: "企业内部管理", links: [ { text: "单点登录", - link: "/guides/authentication/sso/" + link: "/guides/authentication/sso/", }, { text: "多因素认证", - link: "/guides/authentication/mfa/" + link: "/guides/authentication/mfa/", }, { text: "权限管理", - link: "/guides/access-control/" - } - ] + link: "/guides/access-control/", + }, + ], }, { title: "开发者", links: [ { text: "开发文档", - link: "/reference/" + link: "/reference/", }, { text: "框架集成", - link: "/reference/frameworks" + link: "/reference/frameworks", }, { text: "博客", - link: "https://authing.cn/blog" + link: "https://authing.cn/blog", }, { text: "GitHub", - link: "https://github.com/authing" + link: "https://github.com/authing", }, { text: "社区用户中心", - link: "https://forum.authing.cn/" - } - ] - } + link: "https://forum.authing.cn/", + }, + ], + }, ], socials: [ { icon: "authing-github", link: "https://github.com/Authing", - title: "GitHub" + title: "GitHub", }, { icon: "authing-gitter", link: "https://forum.authing.cn/", - title: "Forum" + title: "Forum", }, { icon: "authing-zhihu", link: "https://www.zhihu.com/org/authing", - title: "知乎" - } + title: "知乎", + }, ], // serviceStatus: "服务状态", contactPhone: "400 888 2106", @@ -298,8 +304,8 @@ module.exports = { "成都市高新区天府五街 200 号 1 号楼 B 区 4 楼 406 室(分)", icp: "京ICP备19051205号", beian: "京公网安备 11010802035968号", - companyName: "© 北京蒸汽记忆科技有限公司" - } + companyName: "© 北京蒸汽记忆科技有限公司", + }, }, "/en/": { // text for the language dropdown @@ -320,14 +326,21 @@ module.exports = { search: "Search", searchInDoc: "Search in Docs", oldVersion: "Old Version", + share: { + share: "Share", + copyLink: "Copy Link", + weibo: "Weibo", + wechat: "Wechat QRCode", + copied: "Link Copied", + }, nav: [ { text: "Concept", link: "/en/concepts/" }, { text: "Guides", link: "/en/guides/" }, { text: "Development Integration", link: "/en/reference/" }, { text: "Application integration", - link: "/en/integration/" - } + link: "/en/integration/", + }, ], sidebar: sidebar.enUsNavBar, feedback: { @@ -343,32 +356,32 @@ module.exports = { reasons: [ { value: "内容错误", - label: "Content error" + label: "Content error", }, { value: "缺少代码/图片示例", - label: "Missing code/image example" + label: "Missing code/image example", }, { value: "更新不及时", - label: "Update is not timely" + label: "Update is not timely", }, { value: "太简单/步骤待完善", - label: "Too simple/steps to be perfected" + label: "Too simple/steps to be perfected", }, { value: "链接错误", - label: "Link error" + label: "Link error", }, { value: "其他", - label: "Other" - } + label: "Other", + }, ], customReasonPlaceholder: - "Please describe in detail the problems encountered in the use of the document or suggestions for improvement (optional)" - } + "Please describe in detail the problems encountered in the use of the document or suggestions for improvement (optional)", + }, }, footer: { sections: [ @@ -377,81 +390,81 @@ module.exports = { links: [ { text: "Integrated third-party login", - link: "/en/guides/connections/" + link: "/en/guides/connections/", }, { text: "Mobile phone number flash check", - link: "https://authing.cn/verify" + link: "https://authing.cn/verify", }, { text: "Universal login form component", - link: "/en/reference/ui-components/" + link: "/en/reference/ui-components/", }, { text: "Custom authentication process", - link: "/en/guides/pipeline/" - } - ] + link: "/en/guides/pipeline/", + }, + ], }, { title: "Enterprise internal management", links: [ { text: "Single Sign On", - link: "/en/guides/authentication/sso/" + link: "/en/guides/authentication/sso/", }, { text: "Multi-factor Authentication", - link: "/en/guides/authentication/mfa/" + link: "/en/guides/authentication/mfa/", }, { text: "Authority Management", - link: "/en/guides/access-control/" - } - ] + link: "/en/guides/access-control/", + }, + ], }, { title: "Developers", links: [ { text: "Development Document", - link: "/en/reference/" + link: "/en/reference/", }, { text: "Framework Integration", - link: "/en/reference/frameworks" + link: "/en/reference/frameworks", }, { text: "Blog", - link: "https://authing.cn/blog" + link: "https://authing.cn/blog", }, { text: "GitHub", - link: "https://github.com/authing" + link: "https://github.com/authing", }, { text: "Community User Center", - link: "https://forum.authing.cn/" - } - ] - } + link: "https://forum.authing.cn/", + }, + ], + }, ], socials: [ { icon: "authing-github", link: "https://github.com/Authing", - title: "GitHub" + title: "GitHub", }, { icon: "authing-gitter", link: "https://forum.authing.cn/", - title: "Forum" + title: "Forum", }, { icon: "authing-zhihu", link: "https://www.zhihu.com/org/authing", - title: "ZhiHu" - } + title: "ZhiHu", + }, ], // serviceStatus: "Service Status", contactPhone: "400 888 2106", @@ -461,10 +474,10 @@ module.exports = { contactChenduAddress: "room 406, 4th floor, zone B, building 1, No. 200, Tianfu Fifth Street, Chengdu(branch)", icp: "Beijing ICP No.19051205-1", - companyName: "© Beijing Steamory Technology Co." - } - } - } + companyName: "© Beijing Steamory Technology Co.", + }, + }, + }, }, configureWebpack: (config, isServer) => { return { @@ -478,29 +491,29 @@ module.exports = { // }, // }, output: { - publicPath: process.env.PUBLIC_URL || basePath + publicPath: process.env.PUBLIC_URL || basePath, }, resolve: { alias: { "@imagesZhCn": path.resolve(__dirname, "../images"), - "@imagesEnUs": path.resolve(__dirname, "../en/images") - } + "@imagesEnUs": path.resolve(__dirname, "../en/images"), + }, }, plugins: [ process.env.npm_lifecycle_event !== "docs:dev" && new webpack.optimize.LimitChunkCountPlugin({ - maxChunks: 50 - }) + maxChunks: 50, + }), // new webpack.optimize.MinChunkSizePlugin({ // minChunkSize: 500000, // Minimum number of characters // }), - ].filter(Boolean) + ].filter(Boolean), }; }, extraWatchFiles: [ ".vuepress/enhanceApp.js", ".vuepress/env.js", ".vuepress/sidebar.js", - "README.md" - ] + "README.md", + ], }; diff --git a/docs/.vuepress/enhanceApp.js b/docs/.vuepress/enhanceApp.js index adc6f83eb..b23faf548 100755 --- a/docs/.vuepress/enhanceApp.js +++ b/docs/.vuepress/enhanceApp.js @@ -3,10 +3,12 @@ import VueSelect from "vue-select"; import "vue-select/src/scss/vue-select.scss"; import Pagination from "vue-pagination-2"; import VTooltip from "v-tooltip"; +import VueClipboard from "vue-clipboard2"; export default ({ Vue, options, router, siteData }) => { Vue.use(VueNotification); Vue.use(VTooltip); + Vue.use(VueClipboard); Vue.component("v-select", VueSelect); Vue.component("v-pagination", Pagination); Vue.extend({ diff --git a/docs/.vuepress/theme/components/FeedbackModal.vue b/docs/.vuepress/theme/components/FeedbackModal.vue new file mode 100644 index 000000000..efb69766b --- /dev/null +++ b/docs/.vuepress/theme/components/FeedbackModal.vue @@ -0,0 +1,342 @@ + + + + + diff --git a/docs/.vuepress/theme/components/Page.vue b/docs/.vuepress/theme/components/Page.vue index c6c9b4837..566020f2e 100755 --- a/docs/.vuepress/theme/components/Page.vue +++ b/docs/.vuepress/theme/components/Page.vue @@ -3,7 +3,7 @@ class="page content-layout-container" :class="{ 'full-width': $frontmatter.fullWidthPage, - isInConsole: isInConsole + isInConsole: isInConsole, }" > @@ -15,6 +15,7 @@ + diff --git a/docs/.vuepress/theme/components/SearchInput.vue b/docs/.vuepress/theme/components/SearchInput.vue index 5310c0183..86aab6972 100755 --- a/docs/.vuepress/theme/components/SearchInput.vue +++ b/docs/.vuepress/theme/components/SearchInput.vue @@ -32,7 +32,9 @@ > {{ s.title || s.path }} - > {{ s.header.title }} + > {{ s.header.title }} @@ -49,14 +51,14 @@ export default { name: "SearchBox", props: { - placeholder: String + placeholder: String, }, data() { return { query: "", focused: false, - focusIndex: 0 + focusIndex: 0, }; }, @@ -74,17 +76,17 @@ export default { let { pages } = this.$site; pages = pages // TODO: 暂时隐藏开发集成 新版页面 reference-new - .filter(item => !item.path.includes("reference-new/")) - .map(item => { + .filter((item) => !item.path.includes("reference-new/")) + .map((item) => { return { ...item, title: transformInterpolation(item.title, this), headers: item.headers && - item.headers.map(header => ({ + item.headers.map((header) => ({ ...header, - title: transformInterpolation(header.title, this) - })) + title: transformInterpolation(header.title, this), + })), }; }); const max = @@ -115,7 +117,7 @@ export default { res.push( Object.assign({}, p, { path: p.path + "#" + h.slug, - header: h + header: h, }) ); } @@ -130,7 +132,7 @@ export default { const navCount = (this.$site.themeConfig.nav || []).length; const repo = this.$site.repo ? 1 : 0; return navCount + repo <= 2; - } + }, }, mounted() { @@ -164,7 +166,7 @@ export default { : new Array(searchPaths); return ( - searchPaths.filter(path => { + searchPaths.filter((path) => { return page.path.match(path); }).length > 0 ); @@ -215,8 +217,8 @@ export default { unfocus() { this.focusIndex = -1; - } - } + }, + }, }; @@ -297,9 +299,14 @@ export default { color lighten($textColor, 35%) .page-title font-weight 600 + display block .header + display block font-size 0.9em - margin-left 0.25em + margin-top 0.25em + height 1em + line-height 1em + overflow hidden &.focused background-color #f3f4f5 a diff --git a/docs/.vuepress/theme/components/Share.vue b/docs/.vuepress/theme/components/Share.vue new file mode 100644 index 000000000..613b1c04c --- /dev/null +++ b/docs/.vuepress/theme/components/Share.vue @@ -0,0 +1,169 @@ + + + + + diff --git a/docs/.vuepress/theme/components/SidebarSearch.vue b/docs/.vuepress/theme/components/SidebarSearch.vue index 34708f683..98a02e650 100755 --- a/docs/.vuepress/theme/components/SidebarSearch.vue +++ b/docs/.vuepress/theme/components/SidebarSearch.vue @@ -27,9 +27,7 @@ > {{ s.title || s.path }} - > {{ s.header.title }} + {{ s.nav.join(" / ") }} @@ -47,7 +45,7 @@ export default { props: { placeholder: String, - items: Array + items: Array, }, data() { @@ -55,7 +53,7 @@ export default { query: "", focused: false, focusIndex: 0, - platLinks: [] + platLinks: [], }; }, watch: { @@ -65,8 +63,8 @@ export default { this.calcLinks(); }, immediate: true, - deep: true - } + deep: true, + }, }, computed: { @@ -75,14 +73,14 @@ export default { }, suggestions() { - const query = this.query.trim().toLowerCase(); + const query = this.query.toString().trim().toLowerCase(); if (!query) { return; } if (this.platLinks.length === 0) { this.calcLinks(); } - const result = this.platLinks.filter(item => + const result = this.platLinks.filter((item) => item.keywords.includes(query) ); return result; @@ -93,7 +91,7 @@ export default { const navCount = (this.$site.themeConfig.nav || []).length; const repo = this.$site.repo ? 1 : 0; return navCount + repo <= 2; - } + }, }, mounted() { @@ -107,8 +105,8 @@ export default { methods: { calcLinks() { const result = []; - function calcLinksWithChildren(items) { - items.forEach(item => { + function calcLinksWithChildren(items, nav = []) { + items.forEach((item) => { if (item.path) { result.push({ path: item.path, @@ -117,11 +115,12 @@ export default { .split("/") .pop() .toLowerCase()}${item.title.toLowerCase()}`, - dataIndex: item.dataIndex + dataIndex: item.dataIndex, + nav, }); } if (item.children && item.children.length > 0) { - calcLinksWithChildren(item.children); + calcLinksWithChildren(item.children, [...nav, item.title]); } }); } @@ -175,7 +174,7 @@ export default { unfocus() { this.focusIndex = -1; - } - } + }, + }, }; diff --git a/docs/.vuepress/theme/global-components/LastUpdated.vue b/docs/.vuepress/theme/global-components/LastUpdated.vue index d6512ff06..4621e33fe 100755 --- a/docs/.vuepress/theme/global-components/LastUpdated.vue +++ b/docs/.vuepress/theme/global-components/LastUpdated.vue @@ -10,6 +10,10 @@
+ + + + {{ $localeConfig.githubEdit }} @@ -35,10 +37,11 @@ @@ -74,6 +77,7 @@ export default { align-items center justify-content space-between .github-edit + display flex margin-left 20px a line-height: 20px; diff --git a/docs/.vuepress/theme/util/feishu.js b/docs/.vuepress/theme/util/feishu.js index 511881171..c157e9d6d 100755 --- a/docs/.vuepress/theme/util/feishu.js +++ b/docs/.vuepress/theme/util/feishu.js @@ -1,73 +1,87 @@ -import Axios from 'axios' -import dayjs from 'dayjs' +import Axios from "axios"; +import dayjs from "dayjs"; -const feishuAxios = Axios.create() +const feishuAxios = Axios.create(); export const feishuFeedback = ({ helpful, customReason, reasonList, docUrl, docTitle, + selectedWords, } = {}) => { - const title = helpful ? '文档被赞啦' : '文档被踩啦' + const title = helpful ? "文档被赞啦" : "文档被踩啦"; const content = [ [ { - tag: 'text', - text: `时间:${dayjs().format('YYYY-MM-DD HH:mm:ss')}`, + tag: "text", + text: `时间:${dayjs().format("YYYY-MM-DD HH:mm:ss")}`, }, ], [ { - tag: 'text', - text: '文档标题:', + tag: "text", + text: "文档标题:", }, { - tag: 'text', - text: docTitle || '未知文档标题', + tag: "text", + text: docTitle || "未知文档标题", }, ], [ { - tag: 'text', - text: '文档链接:', + tag: "text", + text: "文档链接:", }, { - tag: 'text', - text: docUrl || '未知链接', + tag: "text", + text: docUrl || "未知链接", }, ], - ] + ]; + + if (selectedWords) { + content.push([ + { + tag: "text", + text: `标记内容:`, + }, + { + tag: "text", + text: selectedWords, + }, + ]); + } if (reasonList) { reasonList.forEach((rea, index) => { content.push([ { - tag: 'text', + tag: "text", text: `被踩理由 ${index + 1}:`, }, { - tag: 'text', + tag: "text", text: rea, }, - ]) - }) + ]); + }); } if (customReason) { content.push([ { - tag: 'text', + tag: "text", text: `反馈详情:${customReason}`, }, - ]) + ]); } return feishuAxios.post( `https://open.feishu.cn/open-apis/bot/v2/hook/f5e7517d-07cb-4519-ab6c-577ad8653ca2`, { - msg_type: 'post', + msg_type: "post", content: { post: { zh_cn: { @@ -77,5 +91,5 @@ export const feishuFeedback = ({ }, }, } - ) -} + ); +}; diff --git a/docs/.vuepress/theme/util/index.js b/docs/.vuepress/theme/util/index.js index a15715d66..1c0d8bfc9 100755 --- a/docs/.vuepress/theme/util/index.js +++ b/docs/.vuepress/theme/util/index.js @@ -1,123 +1,121 @@ -import get from 'lodash/get' +import get from "lodash/get"; -export const hashRE = /#.*$/ -export const extRE = /\.(md|html)$/ -export const endingSlashRE = /\/$/ -export const outboundRE = /^[a-z]+:/i +export const hashRE = /#.*$/; +export const extRE = /\.(md|html)$/; +export const endingSlashRE = /\/$/; +export const outboundRE = /^[a-z]+:/i; export function normalize(path) { - return decodeURI(path) - .replace(hashRE, '') - .replace(extRE, '') + return decodeURI(path).replace(hashRE, "").replace(extRE, ""); } -export function getHash(path) { - const match = path.match(hashRE) +export function getHash(path = "") { + const match = path.match(hashRE); if (match) { - return match[0] + return match[0]; } } export function isExternal(path) { - return outboundRE.test(path) + return outboundRE.test(path); } export function isMailto(path) { - return /^mailto:/.test(path) + return /^mailto:/.test(path); } export function isTel(path) { - return /^tel:/.test(path) + return /^tel:/.test(path); } export function ensureExt(path) { if (isExternal(path)) { - return path + return path; } - const hashMatch = path.match(hashRE) - const hash = hashMatch ? hashMatch[0] : '' - const normalized = normalize(path) + const hashMatch = path.match(hashRE); + const hash = hashMatch ? hashMatch[0] : ""; + const normalized = normalize(path); if (endingSlashRE.test(normalized)) { - return path + return path; } - return normalized + '.html' + hash + return normalized + ".html" + hash; } export function isActive(route, path) { - const routeHash = decodeURIComponent(route.hash) - const linkHash = getHash(path) + const routeHash = decodeURIComponent(route.hash); + const linkHash = getHash(path); if (linkHash && routeHash !== linkHash) { - return false + return false; } - const routePath = normalize(route.path) - const pagePath = normalize(path) - return routePath === pagePath + const routePath = normalize(route.path); + const pagePath = normalize(path); + return routePath === pagePath; } export function resolvePage(pages, rawPath, base, dataIndex) { if (isExternal(rawPath)) { return { - type: 'external', + type: "external", path: rawPath, - } + }; } if (base) { - rawPath = resolvePath(rawPath, base) + rawPath = resolvePath(rawPath, base); } - const path = normalize(rawPath) + const path = normalize(rawPath); for (let i = 0; i < pages.length; i++) { if (normalize(pages[i].regularPath) === path) { - pages[i].dataIndex = dataIndex + pages[i].dataIndex = dataIndex; return Object.assign({}, pages[i], { - type: 'page', + type: "page", path: ensureExt(pages[i].path), - dataIndex: dataIndex - }) + dataIndex: dataIndex, + }); } } console.error( `[vuepress] No matching page found for sidebar item "${rawPath}"` - ) - return {} + ); + return {}; } function resolvePath(relative, base, append) { - const firstChar = relative.charAt(0) - if (firstChar === '/') { - return relative + const firstChar = relative.charAt(0); + if (firstChar === "/") { + return relative; } - if (firstChar === '?' || firstChar === '#') { - return base + relative + if (firstChar === "?" || firstChar === "#") { + return base + relative; } - const stack = base.split('/') + const stack = base.split("/"); // remove trailing segment if: // - not appending // - appending to trailing slash (last segment is empty) if (!append || !stack[stack.length - 1]) { - stack.pop() + stack.pop(); } // resolve relative path - const segments = relative.replace(/^\//, '').split('/') + const segments = relative.replace(/^\//, "").split("/"); for (let i = 0; i < segments.length; i++) { - const segment = segments[i] - if (segment === '..') { - stack.pop() - } else if (segment !== '.') { - stack.push(segment) + const segment = segments[i]; + if (segment === "..") { + stack.pop(); + } else if (segment !== ".") { + stack.push(segment); } } // ensure leading slash - if (stack[0] !== '') { - stack.unshift('') + if (stack[0] !== "") { + stack.unshift(""); } - return stack.join('/') + return stack.join("/"); } /** @@ -128,28 +126,32 @@ function resolvePath(relative, base, append) { * @returns { SidebarGroup } */ export function resolveSidebarItems(page, regularPath, site, localePath) { - const { pages, themeConfig } = site + const { pages, themeConfig } = site; const localeConfig = localePath && themeConfig.locales ? themeConfig.locales[localePath] || themeConfig - : themeConfig + : themeConfig; const pageSidebarConfig = - page.frontmatter.sidebar || localeConfig.sidebar || themeConfig.sidebar - if (pageSidebarConfig === 'auto') { - return resolveHeaders(page) + page.frontmatter.sidebar || localeConfig.sidebar || themeConfig.sidebar; + if (pageSidebarConfig === "auto") { + return resolveHeaders(page); } - const sidebarConfig = localeConfig.sidebar || themeConfig.sidebar + const sidebarConfig = localeConfig.sidebar || themeConfig.sidebar; if (!sidebarConfig) { - return [] + return []; } else { - const { base, config } = resolveMatchingConfig(regularPath, sidebarConfig) - if (config === 'auto') { - return resolveHeaders(page) + const { base, config } = resolveMatchingConfig(regularPath, sidebarConfig); + if (config === "auto") { + return resolveHeaders(page); } - return config ? config.map((item, index) => resolveItem(item, pages, base, 1, `${index}`)) : [] + return config + ? config.map((item, index) => + resolveItem(item, pages, base, 1, `${index}`) + ) + : []; } } @@ -158,42 +160,42 @@ export function resolveSidebarItems(page, regularPath, site, localePath) { * @returns { SidebarGroup } */ function resolveHeaders(page) { - const headers = groupHeaders(page.headers || []) + const headers = groupHeaders(page.headers || []); return [ { - type: 'group', + type: "group", collapsable: false, title: page.title, path: null, children: headers.map((h) => ({ - type: 'auto', + type: "auto", title: h.title, basePath: page.path, - path: page.path + '#' + h.slug, + path: page.path + "#" + h.slug, children: h.children || [], })), }, - ] + ]; } export function groupHeaders(headers) { // group h3s under h2 - headers = headers.map((h) => Object.assign({}, h)) - let lastH2 + headers = headers.map((h) => Object.assign({}, h)); + let lastH2; headers.forEach((h) => { if (h.level === 2) { - lastH2 = h + lastH2 = h; } else if (lastH2) { - ;(lastH2.children || (lastH2.children = [])).push(h) + (lastH2.children || (lastH2.children = [])).push(h); } - }) - return headers.filter((h) => h.level === 2) + }); + return headers.filter((h) => h.level === 2); } export function resolveNavLinkItem(linkItem) { return Object.assign(linkItem, { - type: linkItem.items && linkItem.items.length ? 'links' : 'link', - }) + type: linkItem.items && linkItem.items.length ? "links" : "link", + }); } /** @@ -204,41 +206,41 @@ export function resolveNavLinkItem(linkItem) { export function resolveMatchingConfig(regularPath, config) { if (Array.isArray(config)) { return { - base: '/', + base: "/", config: config, - } + }; } for (const base in config) { if (ensureEndingSlash(regularPath).indexOf(encodeURI(base)) === 0) { return { base, config: config[base], - } + }; } } - return {} + return {}; } function ensureEndingSlash(path) { - return /(\.html|\/)$/.test(path) ? path : path + '/' + return /(\.html|\/)$/.test(path) ? path : path + "/"; } -function resolveItem(item, pages, base, groupDepth = 1, dataIndex = '') { - if (typeof item === 'string') { - return resolvePage(pages, item, base, dataIndex) +function resolveItem(item, pages, base, groupDepth = 1, dataIndex = "") { + if (typeof item === "string") { + return resolvePage(pages, item, base, dataIndex); } else if (Array.isArray(item)) { return Object.assign(resolvePage(pages, item[0], base, dataIndex), { title: item[1], - }) + }); } else { - const children = item.children || [] + const children = item.children || []; if (children.length === 0 && item.path) { return Object.assign(resolvePage(pages, item.path, base, dataIndex), { title: item.title, - }) + }); } return { - type: 'group', + type: "group", path: item.path, title: item.title, sidebarDepth: item.sidebarDepth, @@ -249,18 +251,18 @@ function resolveItem(item, pages, base, groupDepth = 1, dataIndex = '') { resolveItem(child, pages, base, groupDepth + 1, `${dataIndex}-${index}`) ), collapsable: item.collapsable !== false, - } + }; } } export const transformInterpolation = (str, data) => { if (!str) { - return str + return str; } return str.replace(/\{\{([\$\w\.]+?)\}\}/, (matched, $1) => { - return get(data, $1, matched) - }) -} + return get(data, $1, matched); + }); +}; // export const getPlatform = () => { // /* @@ -303,13 +305,19 @@ export const transformInterpolation = (str, data) => { // export { platform } // } //写cookies -export function setCookie(name,value) -{ - var Days = 10; - var exp = new Date(); - exp.setTime(exp.getTime() + Days*24*60*60*1000); - // document.cookie = name + "="+ escape (value) + ";expires=" + exp.toGMTString()+ ";path=/" + ";domain=localhost"; - document.cookie = name + "="+ escape (value) + ";expires=" + exp.toGMTString()+ ";path=/" + ";domain=.authing.cn"; +export function setCookie(name, value) { + var Days = 10; + var exp = new Date(); + exp.setTime(exp.getTime() + Days * 24 * 60 * 60 * 1000); + // document.cookie = name + "="+ escape (value) + ";expires=" + exp.toGMTString()+ ";path=/" + ";domain=localhost"; + document.cookie = + name + + "=" + + escape(value) + + ";expires=" + + exp.toGMTString() + + ";path=/" + + ";domain=.authing.cn"; } //读取cookies @@ -332,7 +340,6 @@ export function getCookie(name) { } //删除cookies -export function delCookie(name) -{ +export function delCookie(name) { setCookie(name, ""); } diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index 9a5b65990..279445d66 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index 1dbca908d..91588ee71 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index 3335d33c2..3429a185c 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index a413c54c2..17aaa5a39 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | string[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index 2b59122df..f50f6af1e 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -186,7 +186,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index ecfde28a8..99bf41af3 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index 74f46e98f..2bfca5b26 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index f69429c2d..845044c55 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index 20a230b39..054923c17 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 4bcb99cad..0d3acbbe0 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index 35e32cced..bc0f33e6f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index 86589b6f9..2fa9181f6 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 85cbdb921..8b305dcc0 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 377843700..662d27862 100644 --- "a/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/csharp/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index caa98671f..541644b11 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -103,7 +102,6 @@ namespace Example DepartmentIds= new List{"624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",} , CustomData= new CreateUserReqDto{ school="北京大学", age=22,} , Password= "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=" , - ResetPasswordOnFisrtLogin= false , TenantIds= new List{} , Identities= new List { @@ -226,7 +224,7 @@ namespace Example | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -271,7 +269,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index c79a582b0..188783e21 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -82,7 +82,6 @@ namespace Example DepartmentIds= new List{"624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",} , CustomData= new CreateUserInfoDto{ school="北京大学", age=22,} , Password= "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=" , - ResetPasswordOnFisrtLogin= false , TenantIds= new List{} , Identities= new List { @@ -213,11 +212,10 @@ namespace Example | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -239,7 +237,7 @@ namespace Example | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -284,7 +282,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index 5de91b4e2..291839efb 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | string[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 85a2cf5ce..abd566cbc 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -174,7 +174,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index a3647d392..899703356 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -155,23 +155,23 @@ namespace Example | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index 5ba9bbc70..e9f83af63 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -174,7 +174,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index eb0ba54ea..86daee520 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index db1540c13..3bcefb6e5 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index f9b89ecbb..107906c6f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | string[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | string[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 87f304c6a..1ad7e13e2 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -190,7 +190,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index a17bf86e0..545f7d61a 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index a6e3d67ad..f133eb327 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index d242d7a34..7d1b8e5a1 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -199,7 +199,7 @@ namespace Example | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -246,7 +246,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index bb044d5bf..5f1586911 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index 66458104e..9bb14590f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -156,15 +156,15 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -191,23 +191,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index cf2825486..dec33ceab 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -140,15 +140,15 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -172,22 +172,22 @@ namespace Example | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index d1b73e83a..477ac7b0c 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index 450c0c600..977dc19b1 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index a7e83c062..336241ec1 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -143,23 +143,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index c83e651e3..79300dcc5 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -141,23 +141,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index 201335c61..66f32f175 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -156,23 +156,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index 2c79aacba..082ce400f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -196,7 +196,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index 35e45ce67..3903c1c17 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -140,22 +140,22 @@ namespace Example | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index f403e5ad7..abcbdecdc 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index f2fe0b8d2..12be2e26f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -194,7 +194,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index 7615c9f7f..c097c6ab3 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -139,23 +139,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index a572559e3..859e0bca0 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -140,22 +140,22 @@ namespace Example | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 6a49e5227..55c5121cd 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -156,15 +156,15 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -191,23 +191,23 @@ namespace Example | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index 755cd739c..710c6421d 100644 --- "a/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/csharp/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -144,15 +144,15 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -176,22 +176,22 @@ namespace Example | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index 5c6ada260..8a2d85dd0 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index 89febbcc7..4a61e3d23 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 42c16d339..cd6682a34 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index e455db9d3..038bc2e37 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index a8bbd6568..316e71c7e 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index 1d84f9e4e..f63a1d63f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index ee509937b..87d4a4480 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -188,7 +188,7 @@ namespace Example | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index b75c566f1..48d82d5d3 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index aaf5e41dd..d79dbe7fd 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index 2854dfae9..11241b2c4 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -117,7 +117,7 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -126,7 +126,7 @@ namespace Example | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index 690de49a3..c6e614381 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index c76c057f6..33b5ca08f 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index ff3c3e33b..4b6aeecff 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -131,7 +131,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index f9227a265..16ffa9d6d 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -120,7 +120,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index 6359d23ea..790263079 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index 24856be56..50a76d98e 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | string[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index 6df032f47..17ace892e 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index 17b9edec3..b81501853 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index 984e3c954..3ce1a7a59 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetType | string | 是 | - | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index 4d309a506..d5efc0f42 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index bcfb877e3..41e18694a 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -108,7 +108,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index ea97382dc..6b6ccfb36 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -108,7 +108,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index 93f9c21c3..c93ec73b5 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index 8b1c1381c..9e11483f2 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -128,7 +128,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index df1ef595c..a21a19a7c 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index 0b2358ee2..7de0ec510 100644 --- "a/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/csharp/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -131,7 +131,7 @@ namespace Example | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index a7cacc56d..4a3f33660 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index b2331d32e..57e19d6e8 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index 2c43a7000..a662306fd 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index fd47b025c..8fafedfd8 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | string[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index e7ecf50a8..f738ed7ed 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -172,7 +172,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index 57689bdce..ab9269cf8 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index 5f847f205..405974290 100644 --- "a/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/go/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index 130ac8912..5f686b6ba 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index d464c5b38..1965190fc 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 7ce6ed207..6bce16e9d 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index 47cdc58a9..a5503b7b1 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index 2c34b77d6..d1da8ab00 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 2547bf308..fda3b807d 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 4c96a9f54..28755882a 100644 --- "a/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/go/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index 91f525ca4..711e8b9c5 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -92,7 +91,6 @@ func main() { DepartmentIds: []string{"624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",}, CustomData: dto.CreateUserReqDto { school="北京大学", age=22,}, Password: "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - ResetPasswordOnFisrtLogin: false, TenantIds: []string{}, Identities: []CreateIdentityDto{ dto.CreateIdentityDto @@ -209,7 +207,7 @@ func main() { | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -254,7 +252,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index 6c0ba1b7b..a8f3aba9c 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -70,7 +70,6 @@ func main() { DepartmentIds: []string{"624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",}, CustomData: dto.CreateUserInfoDto { school="北京大学", age=22,}, Password: "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - ResetPasswordOnFisrtLogin: false, TenantIds: []string{}, Identities: []CreateIdentityDto{ dto.CreateIdentityDto @@ -195,11 +194,10 @@ func main() { | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -221,7 +219,7 @@ func main() { | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -266,7 +264,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index bf26d11fe..d82acd8a9 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | string[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 13afb7f55..853afe513 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -160,7 +160,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index dbe504334..7483760cd 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -141,23 +141,23 @@ func main() { | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index d7f75a8ba..8d5af709c 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -160,7 +160,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index 988f2ca07..17d301e63 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index a266b2008..cbd7a8f49 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index b7d066727..068315823 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | string[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | string[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 494401631..790fd6331 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -176,7 +176,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index 426ea7e8e..527bd2721 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index 5e88ef73e..d13a9b44d 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index bc9c76b9a..22eca9eb8 100644 --- "a/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/go/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -183,7 +183,7 @@ func main() { | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -230,7 +230,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index 41204a16c..b655497f1 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index 3347ccbc9..54ea4631b 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -138,15 +138,15 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -173,23 +173,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index bc73d31e3..fe0dff196 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -122,15 +122,15 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -154,22 +154,22 @@ func main() { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index 63e23545d..6716cfaf7 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index 41d778bfc..32afe0156 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index 602191afb..f49361eda 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -129,23 +129,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index b5c12cabd..56f5bb6bc 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -127,23 +127,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index e9e1ba9c4..fb804e8e7 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -142,23 +142,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index d5b4249c0..b4a559e89 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -182,7 +182,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index ddda8bee2..d4bcd4a16 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -126,22 +126,22 @@ func main() { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index 7727aecb9..9ad1d187f 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index df9fe2b29..fac6699b9 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -180,7 +180,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index 566d0fb98..dedcd1796 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -125,23 +125,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index 606519d26..6bcd72d29 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -126,22 +126,22 @@ func main() { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 1ba777cde..e05beef35 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -138,15 +138,15 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -173,23 +173,23 @@ func main() { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index c3ea4f3cc..78e2c28b1 100644 --- "a/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/go/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -126,15 +126,15 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -158,22 +158,22 @@ func main() { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index 09d180ac8..77f0a1352 100644 --- "a/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index d0dc964ea..7c2145fb5 100644 --- "a/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/go/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 10edeb197..49c950ecb 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index ae8de4ad1..b613a2e5f 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index 8d2bbd245..f265f0998 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index e54b0afff..047549d04 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index 5e909e538..f2f676678 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -174,7 +174,7 @@ func main() { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index 80bbfba58..5aeb8b12a 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index 792b52a08..6fa3a253d 100644 --- "a/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/go/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index 8c8ffc9c1..3d83ea23a 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -101,7 +101,7 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -110,7 +110,7 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index 16ed85588..6be013ec5 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index 1db700281..f4b01a7a8 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index c4782e4c2..789e499ed 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -116,7 +116,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index 3e5823171..8a47c1a33 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -104,7 +104,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index aa12d8fca..24546a7a7 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index 0d9fabd8b..4e64299d1 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | string[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index 79142851b..85e5d018a 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index 063dc3870..afa6a1faf 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index d0c0cf43c..c6440052c 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetIdentifier | string | 是 | - | 目标对象唯一标志符。 | `userId1` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index 2edb0e8c8..2dd3f7625 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index 0f124771b..acc5b91d6 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -94,7 +94,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index 73d1eccd7..9dd2f0b96 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -94,7 +94,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index cd4d5d561..78d2b4d17 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index 73fe73ed8..76a034812 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -114,7 +114,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index 00db0f30b..8f7e9b276 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index 3762cc2ee..eb86d4385 100644 --- "a/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/go/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -116,7 +116,7 @@ func main() { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index c6566637b..5f28d82f5 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index 6b3fd6bef..96a4573d9 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index d237f5b8c..6ba51e41d 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index 1d9b2448c..4eb509c23 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | string[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index fec20d4f6..8de81584b 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -165,7 +165,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index 631386afe..9a81c8d25 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index be87e67a7..1e88b6665 100644 --- "a/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/java/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index 6fe938c8b..efe82e991 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index 428af2ab7..686d4b8bd 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 88a442840..2cbd5b692 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index f9d33225d..19eb54d23 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index dee1da133..8f109e55c 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 9219122ed..fc9f7c624 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 8902ed2df..6ec1ab1dc 100644 --- "a/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/java/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index e9d4635f7..47edddb9f 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -83,7 +82,6 @@ class ManagementClientTest { request.setDepartmentIds(new List("624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",)); request.setCustomData(new CreateUserReqDto.setSchool("北京大学",.setAge(age22,)); request.setPassword("oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY="); - request.setResetPasswordOnFisrtLogin(false); request.setTenantIds(new List()); Identities= new List( new CreateIdentityDto().set @@ -202,7 +200,7 @@ class ManagementClientTest { | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -247,7 +245,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index 4f9144043..d69b39c05 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -61,7 +61,6 @@ class ManagementClientTest { request.setDepartmentIds(new List("624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe",)); request.setCustomData(new CreateUserInfoDto.setSchool("北京大学",.setAge(age22,)); request.setPassword("oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY="); - request.setResetPasswordOnFisrtLogin(false); request.setTenantIds(new List()); Identities= new List( new CreateIdentityDto().set @@ -188,11 +187,10 @@ class ManagementClientTest { | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -214,7 +212,7 @@ class ManagementClientTest { | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -259,7 +257,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index 7dfc770bd..f4c3c429b 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | string[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 44b83d1c1..5b4069aba 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -153,7 +153,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index a30b83a3a..d1ab6a67f 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -134,23 +134,23 @@ class ManagementClientTest { | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index eb20468c3..570e67516 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -153,7 +153,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index 28978c43e..65651b027 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index eff435649..b35cb51e7 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index 182dd8b89..86da21eef 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | string[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | string[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 3cf5f2b06..fdc78a6af 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -169,7 +169,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index e2bc32b78..8bd966ef8 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index 5771224d2..afa0d078f 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index 44f096be3..2fe8b54d8 100644 --- "a/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/java/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -176,7 +176,7 @@ class ManagementClientTest { | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -223,7 +223,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index dc2cc8c08..5f240410b 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index 4bd6a8400..2c1a662cc 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -131,15 +131,15 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -166,23 +166,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index d54b37b04..d8446f24a 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -115,15 +115,15 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -147,22 +147,22 @@ class ManagementClientTest { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index 2bb772aff..fc33e87d7 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index 5118058e0..19465850c 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index 05de6a994..c10916751 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -122,23 +122,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index 7edce0767..1336002ad 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -120,23 +120,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index f8096355e..363e0954e 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -135,23 +135,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index 3b9b88bfc..26d1ee0d8 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -175,7 +175,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index f2840ed7d..53cc2b0f6 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -119,22 +119,22 @@ class ManagementClientTest { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index 25bf62d24..761585966 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index 926004767..93d6840bd 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -173,7 +173,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index c019d9aa8..baa5223e1 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -118,23 +118,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index 7bada4feb..aaa75143c 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -119,22 +119,22 @@ class ManagementClientTest { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 6d405d7a5..ad87ba5b9 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -131,15 +131,15 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -166,23 +166,23 @@ class ManagementClientTest { | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index 3d23112fd..01c295aa4 100644 --- "a/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/java/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -119,15 +119,15 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -151,22 +151,22 @@ class ManagementClientTest { | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index 6d7ea08d3..5089f5295 100644 --- "a/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index 6257a87a4..3aa0d9770 100644 --- "a/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/java/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 1d16c336f..a28789663 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index 87a82b839..81fd8e9ce 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index aea0973f5..5fcb751bc 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index d32706218..7453fd336 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index 56628595b..8cb3c3a44 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -167,7 +167,7 @@ class ManagementClientTest { | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index 130626831..ea41fde21 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index 540543d24..6fedb56fd 100644 --- "a/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/java/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index 3b81569e9..289e6f450 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -94,7 +94,7 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -103,7 +103,7 @@ class ManagementClientTest { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index 4e3a752b8..79c5fd80f 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index 8475fd439..06c4da4d8 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index c407ad31b..49f69f2c6 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -109,7 +109,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index 48638b796..593e3a7fd 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -97,7 +97,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index 60f7246d4..831023f18 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index c1672fe3a..011ff21f6 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | string[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index 408dee8d7..1f8b45886 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index df3c56137..664496521 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index 8bd1cd68f..d40cdefc5 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetType | string | 是 | - | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index 286349f71..bc74b3518 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index 79b598356..89d209553 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -87,7 +87,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index c7cc8923b..490648c0c 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -87,7 +87,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index c36c93d48..dc430230f 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index a636a6dd0..fad86d140 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -107,7 +107,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index a6525f5a7..a5ca383b4 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index eff26711f..03218cc23 100644 --- "a/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/java/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -109,7 +109,7 @@ class ManagementClientTest { | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index bac39f3df..d1703b44b 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index b21ab46f4..5353341d2 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index 0138a51bf..7568848e7 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index 18f67ce53..8f3e0177c 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | string[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index 688bf6202..6dc4504da 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -166,7 +166,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index d2af347dc..bb5654b68 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index 4467bb251..e7737e20e 100644 --- "a/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/node/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index 87f8ff693..13c7ba686 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index c2e496e7b..9793a2581 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 1110cd2db..5f312a962 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index fe411e4e0..613c0e08e 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index eb84ea5ee..864ac0fcb 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 026b2d01f..e9ab63c01 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 51fd4580f..6771e5d3b 100644 --- "a/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/node/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index 3545c06e5..79013879c 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -84,7 +83,6 @@ const managementClient = new ManagementClient({ "age": 22 }, password: 'oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=', - resetPasswordOnFisrtLogin: false, tenantIds: undefined, identities: [{ extIdpId: '6076bacxxxxxxxxd80d993b5', @@ -197,7 +195,7 @@ const managementClient = new ManagementClient({ | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -242,7 +240,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index fe1537b94..20101a9f3 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -60,7 +60,6 @@ const managementClient = new ManagementClient({ "age": 22 }, password: 'oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=', - resetPasswordOnFisrtLogin: false, tenantIds: undefined, identities: [{ extIdpId: '6076bacxxxxxxxxd80d993b5', @@ -180,11 +179,10 @@ const managementClient = new ManagementClient({ | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -206,7 +204,7 @@ const managementClient = new ManagementClient({ | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -251,7 +249,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index ab0a93253..6cb820947 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | string[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 25e8519e5..c240e6629 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -153,7 +153,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index 352cfeaf0..e687432f6 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -136,23 +136,23 @@ const managementClient = new ManagementClient({ | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index f2974d960..c6d29697d 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -153,7 +153,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index e40b25807..40e21cfac 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index 336a1c816..ee04dfaa5 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index 74c28a475..eb434ca83 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | string[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | string[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 45bc6cbb7..8b667ab43 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -172,7 +172,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index a69df5550..bfd35b9e3 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index 588e685e5..1a7bb1676 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index 99ff1aacd..6e79ca50e 100644 --- "a/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/node/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -174,7 +174,7 @@ const managementClient = new ManagementClient({ | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -221,7 +221,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index 457e791c6..76493c3a5 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index b737cd18a..012575c95 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -128,15 +128,15 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -163,23 +163,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index 8e1d45f50..748f5b839 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -110,15 +110,15 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -142,22 +142,22 @@ const managementClient = new ManagementClient({ | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index 286652bb5..a2177e78f 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index c4e227438..becae9a9f 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index 2a672c313..8c7abfbf0 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -122,23 +122,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index 8814cb771..ee1a96f6d 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -119,23 +119,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index d0199fa08..d06e490c2 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -136,23 +136,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index 70b6b20ee..1bb9f562c 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -181,7 +181,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index 104bec578..4e35e78ed 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -117,22 +117,22 @@ const managementClient = new ManagementClient({ | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index e7cb953c3..5bb821537 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index 59383f7a6..011a1bb33 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -178,7 +178,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index 54dc999ae..eb529a1ad 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -113,23 +113,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index 963806bea..60c7b8c4b 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -117,22 +117,22 @@ const managementClient = new ManagementClient({ | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 0963d2642..a34d636bd 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -128,15 +128,15 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -163,23 +163,23 @@ const managementClient = new ManagementClient({ | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index 169508558..b188720a0 100644 --- "a/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/node/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -114,15 +114,15 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -146,22 +146,22 @@ const managementClient = new ManagementClient({ | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index bb4c32784..12a6c8371 100644 --- "a/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index 3c707a15a..492d20067 100644 --- "a/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/node/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 922bc7aeb..6ec1bc5a0 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index 54938932e..7c3a9c072 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index 1c7e7e9e1..75f05221b 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index d46166050..1296b676a 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index 14060df7d..215389ceb 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -169,7 +169,7 @@ const managementClient = new ManagementClient({ | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index 202d956d5..296bfa0e3 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index 8897e2dbb..4146935db 100644 --- "a/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/node/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index f1d56da70..9e55ef5c8 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -83,7 +83,7 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -92,7 +92,7 @@ const managementClient = new ManagementClient({ | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index 7bcf43c72..5cd0df859 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index 73ed2e9d0..69172d22e 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index 162b880c8..e1b3857bf 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -101,7 +101,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index 37947870d..506ea4cce 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -86,7 +86,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index dcf98a964..0531f5de8 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index 5fa8b1a14..893585928 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | string[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index a4f18a12d..401634599 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index f81f08903..b88b1076c 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index 834597e77..6c06eb4fb 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetIdentifier | string | 是 | - | 目标对象唯一标志符。 | `userId1` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index 5cb0253f4..e6dda8ffd 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index 4d62732d6..9a35f3298 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -84,7 +84,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index 73c469876..e5075c2dd 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -34,7 +34,7 @@ const managementClient = new ManagementClient({ (async () => { const result = await managementClient.getResourcesBatch({ - codeList: code1,code2, + codeList: ["code1","code2"], namespace: 'default', }); @@ -84,7 +84,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index 7c6b52633..7dd7d5ded 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index 34a7f15aa..ffe6e2356 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -106,7 +106,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index c973579c2..af8640ef5 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index 2ebb36b86..0baf63b0b 100644 --- "a/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/node/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -101,7 +101,7 @@ const managementClient = new ManagementClient({ | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index a78dda053..c0d25ae43 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index ff65fba67..8a0618a58 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index d031369a0..1178fb774 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index 09811d5fa..a34a89ae5 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | string[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index 50149e7a5..b4f9f0eb1 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -166,7 +166,7 @@ $data = $management->listGroupMembers(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index 3d8536b14..9917e9978 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | string[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index 3e2a90de6..0d3f8daf8 100644 --- "a/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/php/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index 2807fa579..84f8faee7 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index 9e31ffdb7..172eee9d5 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 41ad10ec9..47e3fb04d 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index 8eef8ae3b..20c3b652e 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index df82d0145..127547682 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 28e31d66f..eaa578963 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 553ed6034..3fa3d1280 100644 --- "a/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/php/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index 24cbe61ff..895ab5583 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | string[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -85,7 +84,6 @@ $data = $management->createUser(array( "age"=> 22 ), "password" => "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - "resetPasswordOnFisrtLogin" => false, "tenantIds" => "undefined", "identities" => array( array( @@ -200,7 +198,7 @@ $data = $management->createUser(array( | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -245,7 +243,7 @@ $data = $management->createUser(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index 86f7068e8..51ad6d95a 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -62,7 +62,6 @@ $data = $management->createUsersBatch(array( "age"=> 22 ), "password" => "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - "resetPasswordOnFisrtLogin" => false, "tenantIds" => "undefined", "identities" => array( array( @@ -186,11 +185,10 @@ $data = $management->createUsersBatch(array( | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -212,7 +210,7 @@ $data = $management->createUsersBatch(array( | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -257,7 +255,7 @@ $data = $management->createUsersBatch(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index dd85e55a5..7e62c1ad1 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | string[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 5b62e3c0c..a94852eda 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -153,7 +153,7 @@ $data = $management->getUserBatch(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index 8387eb972..ae01906b5 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -136,23 +136,23 @@ $data = $management->getUserDepartments(array( | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index e5d1497de..4eb68c852 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -153,7 +153,7 @@ $data = $management->getUser(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index f32524924..878a8b74a 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index c2181d7e8..536f4ecfd 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index 86360e5a1..e53df5757 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | string[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | string[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 85c77960d..0d913cd35 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -172,7 +172,7 @@ $data = $management->listUsers(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index ad72e895c..4b3baafcd 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index 9a1e5edb0..2ee3f1a51 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index 87e6070d5..eaebb62ad 100644 --- "a/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/php/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -174,7 +174,7 @@ $data = $management->updateUser(array( | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -221,7 +221,7 @@ $data = $management->updateUser(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index 783d2cf66..0dab5a745 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index f7fcab987..a2406bc20 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -128,15 +128,15 @@ $data = $management->createDepartment(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -163,23 +163,23 @@ $data = $management->createDepartment(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index 9ed105ba9..b5b9cde75 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -110,15 +110,15 @@ $data = $management->createOrganization(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -142,22 +142,22 @@ $data = $management->createOrganization(array( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index 3b4b3ba69..e97b6fef4 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index 653d66108..e6f4f4efa 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index 5ba6e82a3..6bd49623a 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -122,23 +122,23 @@ $data = $management->getDepartment(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index 0b9c8176f..47a9b9475 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -119,23 +119,23 @@ $data = $management->getParentDepartment(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index ba335fa9b..01b7b58b5 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -136,23 +136,23 @@ $data = $management->listChildrenDepartments(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index d0a9f1f91..a525f52bb 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -181,7 +181,7 @@ $data = $management->listDepartmentMembers(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index b6e4aca8c..3e364321d 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -117,22 +117,22 @@ $data = $management->listOrganizations(array( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index 39395683d..a102ccb44 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | string[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index 2044527cf..33855b46a 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -178,7 +178,7 @@ $data = $management->searchDepartmentMembers(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index 840d93819..36b6f414c 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -113,23 +113,23 @@ $data = $management->searchDepartments(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index 55ea00aac..ae9c22ef3 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -117,22 +117,22 @@ $data = $management->searchOrganizations(array( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 6f751cf3c..5408a7666 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -128,15 +128,15 @@ $data = $management->updateDepartment(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -163,23 +163,23 @@ $data = $management->updateDepartment(array( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index c570e4836..14927fe7d 100644 --- "a/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/php/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | string[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -114,15 +114,15 @@ $data = $management->updateOrganization(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -146,22 +146,22 @@ $data = $management->updateOrganization(array( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index e9a3342d3..a8b66f9b8 100644 --- "a/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index e3ab5432e..db2074f72 100644 --- "a/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/php/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 63e31d9e9..b8ba1fdd0 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index 45272f47b..76e094ab8 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index 945ac956d..6a61f0af2 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index ef9d2e5d7..37bbae124 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index 1c4fab916..e6ba92d86 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -169,7 +169,7 @@ $data = $management->listRoleMembers(array( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index 17f4a9162..d4e07d60b 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index 300e14948..e840ead7f 100644 --- "a/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/php/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index 58351a071..29e0d1d0c 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -89,7 +89,7 @@ $data = $management->authorizeResources(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -98,7 +98,7 @@ $data = $management->authorizeResources(array( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index 2e41a6d42..bd6fb615e 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index 1260eec4f..4349b415c 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index 275162c5f..1cb734045 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -104,7 +104,7 @@ $data = $management->createResource(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index 2f4d5b540..4c6a3191c 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -92,7 +92,7 @@ $data = $management->createResourcesBatch(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index 939c550b9..59e64344e 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index c199baa1f..4d5a8979f 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | string[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index c71b0d440..1bcdb9652 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index c8594e395..57bb249af 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | string[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index 0f13ad7fc..1288c8d7e 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetType | string | 是 | - | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index de384996e..feae693d8 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index fcf0edcd0..7c1475475 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -84,7 +84,7 @@ $data = $management->getResource(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index 5601aca17..9a9493008 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -84,7 +84,7 @@ $data = $management->getResourcesBatch(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index a9a974fe9..e4ad50938 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index f8061c84e..8f4c88f1c 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -106,7 +106,7 @@ $data = $management->listResources(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index 14392a7bb..656501c6f 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index 3823bde37..7f8b2354d 100644 --- "a/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/php/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -104,7 +104,7 @@ $data = $management->updateResource(array( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" index 33fdd2056..30c7ba383 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/add-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | array[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | array[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" index c760c0dd2..fa6530776 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-group.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" index e4983365a..d5b40ae3b 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/create-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateGroupReqDto[] | 是 | - | 批量分组。 | | +| list | CreateGroupReqDto[] | 是 | - | 批量分组。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" index a5e74c748..10b522e48 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/delete-groups-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | array[] | 是 | - | 分组 code 列表。 | `["code1"]` | +| codeList | array[] | 是 | - | 分组 code 列表。 数组长度限制:50。 | `["code1"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" index 52244e35e..f57adf0f0 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/list-group-members.md" @@ -163,7 +163,7 @@ data = management_client.list_group_members( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" index e0e0c6cea..4aff8dcfe 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/remove-group-members.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | array[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9"]` | -| code | string | 是 | - | 分组 code。 | `developer` | +| userIds | array[] | 是 | - | 用户 ID 数组。 数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9"]` | +| code | string | 是 | - | 分组 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" index 020197e17..b2cbaa052 100644 --- "a/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" +++ "b/docs/reference-new/sdk-v5/python/\345\210\206\347\273\204\347\256\241\347\220\206/update-group.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| description | string | 是 | - | 分组描述。 | `描述内容` | -| name | string | 是 | - | 分组名称。 | `开发者` | -| code | string | 是 | - | 分组 code。 | `developer` | -| newCode | string | 否 | - | 分组新的 code。 | `developer` | +| description | string | 是 | - | 分组描述。 | `描述内容` | +| name | string | 是 | - | 分组名称。 | `开发者` | +| code | string | 是 | - | 分组 code。 | `developer` | +| newCode | string | 否 | - | 分组新的 code。 | `developer` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" index a6065d472..5d7c0db5b 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp-conn.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | -| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | -| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | -| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| fields | object | 是 | - | 连接的自定义配置信息。 | `{"clientId":"身份源上的 clientId","clientSecret":"身份源上的 clientSecret"}` | +| displayName | string | 是 | - | 连接在登录页的显示名称。 | `登录页` | +| identifier | string | 是 | - | 身份源连接标识。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`alipay`,`facebook`,`twitter`,`google`,`wechat:pc`,`wechat:mobile`,`wechat:webpage-authorization`,`wechatmp-qrcode`,`wechat:miniprogram:default`,`wechat:miniprogram:qrconnect`,`wechat:miniprogram:app-launch`,`github`,`qq`,`wechatwork:corp:qrconnect`,`wechatwork:agency:qrconnect`,`wechatwork:service-provider:qrconnect`,`wechatwork:mobile`,`dingtalk`,`dingtalk:provider`,`weibo`,`apple`,`apple:web`,`baidu`,`lark-internal`,`lark-public`,`gitlab`,`linkedin`,`slack`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| extIdpId | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| logo | string | 否 | - | 身份源图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" index 3a120f343..4f3173569 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/create-ext-idp.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | -| name | string | 是 | - | 身份源名称。 | `exampleName` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| type | string | 是 | - | 身份源连接类型。 枚举值:`oidc`,`oauth2`,`saml`,`ldap`,`ad`,`cas`,`azure-ad`,`wechat`,`google`,`qq`,`wechatwork`,`dingtalk`,`weibo`,`github`,`alipay`,`apple`,`baidu`,`lark`,`gitlab`,`twitter`,`facebook`,`slack`,`linkedin`,`yidun`,`qingcloud`,`gitee`,`instagram`,`welink` | `ad` | +| name | string | 是 | - | 身份源名称。 | `exampleName` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" index 12a132979..c0f081c07 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp-conn.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" index dff2a0ebd..d3b26ee5c 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/delete-ext-idp.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" index 1437546c5..bb729899e 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/enable-ext-idp-conn.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | -| enabled | boolean | 是 | - | 是否开启身份源连接。 | | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | +| appId | string | 是 | - | 应用 ID。 | `60b49eb83fd80adb96f26e68` | +| enabled | boolean | 是 | - | 是否开启身份源连接。 | | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| tenantId | string | 否 | - | 租户 ID。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" index 176594d76..530abbfd1 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp-conn.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | -| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | -| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | -| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | -| loginOnly | boolean | 否 | - | 是否只支持登录。 | | +| fields | object | 是 | - | 身份源连接自定义参数(增量修改)。 | `{"clientId":"clientId"}` | +| displayName | string | 是 | - | 身份源连接显示名称。 | `exampleName` | +| id | string | 是 | - | 身份源连接 ID。 | `60b49eb83fd80adb96f26e68` | +| logo | string | 否 | - | 身份源连接的图标。 | `https://files.authing.co/authing-console/social-connections/icon_xiaochengxu@2x.png` | +| loginOnly | boolean | 否 | - | 是否只支持登录。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" index 54827f155..7b0b80db0 100644 --- "a/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" +++ "b/docs/reference-new/sdk-v5/python/\345\244\226\351\203\250\350\272\253\344\273\275\346\272\220\347\256\241\347\220\206/update-ext-idp.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | -| name | string | 是 | - | 名称。 | `exampleName` | +| id | string | 是 | - | 身份源 ID。 | `60b49eb83fd80adb96f26e68` | +| name | string | 是 | - | 名称。 | `exampleName` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" index 50f37766c..39b6612f3 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-user.md" @@ -15,33 +15,32 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| departmentIds | array[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | - | 是否首次登录时重新设置密码。 | `false` | -| tenantIds | string[] | 否 | - | 租户 ID。 | | -| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| departmentIds | array[] | 否 | - | 用户所属部门 ID 列表。 | `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| tenantIds | string[] | 否 | - | 租户 ID。 | | +| identities | CreateIdentityDto[] | 否 | - | 第三方身份源(建议调用绑定接口进行绑定)。 | `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -81,7 +80,6 @@ data = management_client.create_user( "age": 22 }, password: "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - reset_password_on_fisrt_login: false, tenant_ids: "undefined", identities: [{ ext_idp_id: "6076bacxxxxxxxxd80d993b5", @@ -194,7 +192,7 @@ data = management_client.create_user( | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -239,7 +237,7 @@ data = management_client.create_user( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" index 7444d2945..d9ab4b497 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/create-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateUserInfoDto[] | 是 | - | 用户列表。 | | -| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | +| list | CreateUserInfoDto[] | 是 | - | 用户列表。 数组长度限制:50。 | | +| options | CreateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -57,7 +57,6 @@ data = management_client.create_users_batch( "age": 22 }, password: "oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=", - reset_password_on_fisrt_login: false, tenant_ids: "undefined", identities: [{ ext_idp_id: "6076bacxxxxxxxxd80d993b5", @@ -177,11 +176,10 @@ data = management_client.create_users_batch( | postalCode | string | 否 | 邮政编码号。 示例值: `438100` | | externalId | string | 否 | 第三方外部 ID。 示例值: `10010` | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | -| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `[object Object]` | +| customData | object | 否 | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 示例值: `{"school":"北京大学","age":22}` | | password | string | 否 | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 示例值: `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| resetPasswordOnFisrtLogin | boolean | 否 | 是否首次登录时重新设置密码。 示例值: `false` | | tenantIds | array | 否 | 租户 ID。 | -| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `[object Object]` | +| identities | array | 否 | 第三方身份源(建议调用绑定接口进行绑定)。嵌套类型:CreateIdentityDto。 示例值: `{"extIdpId":"6076bacxxxxxxxxd80d993b5","provider":"wechat","type":"openid","userIdInIdp":"oj7Nq05R-RRaqak0_YlMLnnIwsvg"}` | ### CreateIdentityDto @@ -203,7 +201,7 @@ data = management_client.create_users_batch( | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | | resetPasswordOnFirstLogin | boolean | 否 | 是否强制要求用户在第一次的时候重置密码。 | | departmentIdType | string | 否 | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | -| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `[object Object]` | +| sendNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendCreateAccountNotificationDto。 示例值: `{"sendEmailNotification":true,"sendPhoneNotification":true}` | ### SendCreateAccountNotificationDto @@ -248,7 +246,7 @@ data = management_client.create_users_batch( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" index 7efe08060..072ae86d6 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/delete-users-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | array[] | 是 | - | 用户 ID 列表。 | `["userId1","userId2"]` | -| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | +| userIds | array[] | 是 | - | 用户 ID 列表。 数组长度限制:50。 | `["userId1","userId2"]` | +| options | DeleteUsersBatchOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" index 257b52ea8..f1e475c2d 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | string[] | 是 | - | 用户 ID 数组。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | +| userIds | string[] | 是 | - | 用户 ID 数组。数组长度限制:50。 | `["6229ffaxxxxxxxxcade3e3d9","6229ffaxxxxxxxxcade3e3d0"]` | | userIdType | string | 否 | user_id | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | `user_id` | | withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | | withIdentities | boolean | 否 | - | 是否获取 identities。 | `true` | @@ -150,7 +150,7 @@ data = management_client.get_user_batch( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" index cbd85afc6..c4b1b1437 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user-departments.md" @@ -133,23 +133,23 @@ data = management_client.get_user_departments( | isMainDepartment | boolean | 是 | 是否是主部门。 示例值: `true` | | joinedAt | string | 是 | 加入部门时间。 示例值: `2022-07-03T02:20:30.000Z` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" index 3dc42290a..0e68f186c 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/get-user.md" @@ -150,7 +150,7 @@ data = management_client.get_user( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" index 2b87cad79..0332aec1d 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/has-any-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | +| roles | HasRoleRolesDto[] | 是 | - | 角色列表。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | HasAnyRoleOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" index 224bbd261..7b54a2086 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/is-user-exists.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" index fdc00cdaf..ce5c9fbba 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/kick-users.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| appIds | array[] | 是 | - | APP ID 列表。 | `["62188e71cxxxx3075289c580"]` | -| userId | string | 是 | - | 用户 ID。 | | -| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | +| appIds | array[] | 是 | - | APP ID 列表。 数组长度限制:50。 | `["62188e71cxxxx3075289c580"]` | +| userId | string | 是 | - | 用户 ID。 | | +| options | KickUsersOptionsDto | 否 | - | 可选参数。 | `{"userIdType":"user_id"}` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" index 69148a81e..be069231c 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/list-users.md" @@ -169,7 +169,7 @@ data = management_client.list_users( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" index 64d158c7c..6451430e3 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/reset-user-principal-authentication-info.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | ResetUserPrincipalAuthenticationInfoOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" index 6414601dc..b6a9f2b06 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/set-user-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | +| departments | SetUserDepartmentDto[] | 是 | - | 部门信息。 数组长度限制:10。 | `[{"departmentId":"60b49eb83fd80adb96f26e68","isLeader":true,"isMainDepartment":true}]` | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| options | SetUserDepartmentsOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" index 6da5d44d4..881d47e99 100644 --- "a/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" +++ "b/docs/reference-new/sdk-v5/python/\347\224\250\346\210\267\347\256\241\347\220\206/update-user.md" @@ -15,30 +15,30 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | -| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | -| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | -| nickname | string | 否 | - | 昵称。 | `张三` | -| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | -| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | -| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | -| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | -| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | -| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | -| country | string | 否 | - | 所在国家。 | `CN` | -| province | string | 否 | - | 所在省份。 | `BJ` | -| city | string | 否 | - | 所在城市。 | `BJ` | -| address | string | 否 | - | 所处地址。 | `北京朝阳` | -| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | -| postalCode | string | 否 | - | 邮政编码号。 | `438100` | -| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | -| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | -| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | -| email | string | 否 | - | 邮箱。 | `test@example.com` | -| phone | string | 否 | - | 手机号。 | `176xxxx6754` | -| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | -| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | +| userId | string | 是 | - | 用户 ID。 | `6229ffaxxxxxxxxcade3e3d9` | +| phoneCountryCode | string | 否 | - | 手机区号。 | `+86` | +| name | string | 否 | - | 用户真实名称,不具备唯一性。 | `张三` | +| nickname | string | 否 | - | 昵称。 | `张三` | +| photo | string | 否 | - | 头像链接。 | `https://files.authing.co/authing-console/default-user-avatar.png` | +| externalId | string | 否 | - | 第三方外部 ID。 | `10010` | +| status | string | 否 | Activated | 账户当前状态。 枚举值:`Suspended`,`Resigned`,`Activated`,`Archived` | `Activated` | +| emailVerified | boolean | 否 | - | 邮箱是否验证。 | `true` | +| phoneVerified | boolean | 否 | - | 手机号是否验证。 | `true` | +| birthdate | string | 否 | - | 出生日期。 | `2022-06-03` | +| country | string | 否 | - | 所在国家。 | `CN` | +| province | string | 否 | - | 所在省份。 | `BJ` | +| city | string | 否 | - | 所在城市。 | `BJ` | +| address | string | 否 | - | 所处地址。 | `北京朝阳` | +| streetAddress | string | 否 | - | 所处街道地址。 | `北京朝阳区 xxx 街道` | +| postalCode | string | 否 | - | 邮政编码号。 | `438100` | +| gender | string | 否 | U | 性别。 枚举值:`M`,`W`,`U` | `M` | +| username | string | 否 | - | 用户名,用户池内唯一。 | `bob` | +| passwordEncryptType | string | 否 | none | 密码加密类型,支持 sm2 和 rsa。 枚举值:`sm2`,`rsa`,`none` | `none` | +| email | string | 否 | - | 邮箱。 | `test@example.com` | +| phone | string | 否 | - | 手机号。 | `176xxxx6754` | +| password | string | 否 | - | 密码。可选加密方式进行加密,通过 passwordEncryptType 参数进行加密方法选择,默认为未加密。 | `oqw5bhVmlDwF5qqeVA645bICyMVfFaV3sf3ZTrk5Npcm5dTOmBVo1anyZ5JLfHAz/P45r0QTPo8xS1YdKxIrshx4Ju+g04s9SQqW30ebdVdqcOntIJGAXU6arrkPvfcRFV3ZVTwBdgdRWHMkr5sTcnGNYdgL67P9/jHnzltkLbY=` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"school":"北京大学","age":22}` | +| options | UpdateUserOptionsDto | 否 | - | 可选参数。 | | ## 示例代码 @@ -171,7 +171,7 @@ data = management_client.update_user( | userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:`user_id`,`external_id`,`phone`,`email`,`username` | | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | autoGeneratePassword | boolean | 否 | 是否自动生成密码。 | -| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `[object Object]` | +| sendPasswordResetedNotification | | 否 | 重置密码发送邮件和手机号选项。嵌套类型:SendResetPasswordNotificationDto。 示例值: `{"sendDefaultEmailNotification":false,"sendDefaultPhoneNotification":false,"inputSendEmailNotification":"test@example.com","inputSendPhoneNotification":"136xxxx1234","appId":"app1"}` | ### SendResetPasswordNotificationDto @@ -218,7 +218,7 @@ data = management_client.update_user( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" index 6d984bf03..10b41de7a 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/add-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | array[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | array[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" index 4571abc02..9a2ec3e98 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | -| name | string | 是 | - | 部门名称。 | `开发部` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 是 | - | 父部门 id。 | `6229c4deb3e4d8a20b6021ff` | +| name | string | 是 | - | 部门名称。 | `开发部` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| openDepartmentId | string | 否 | - | 自定义部门 ID,用于存储自定义的 ID。 | `ou_7dab8a3d3cdccxxxxxx777c7ad535d62` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| isVirtualNode | boolean | 否 | - | 是否是虚拟部门。 | | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | - | 部门的扩展字段数据。 | `{"icon":"https://example.com/logo"}` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的父部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 @@ -125,15 +125,15 @@ data = management_client.create_department( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -160,23 +160,23 @@ data = management_client.create_department( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" index a1b5aab89..a860a26b5 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/create-organization.md" @@ -15,11 +15,11 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationName | string | 是 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 组织描述信息。 | `组织描述信息` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ## 示例代码 @@ -107,15 +107,15 @@ data = management_client.create_organization( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -139,22 +139,22 @@ data = management_client.create_organization( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" index fb69aecba..2663cdffd 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-department.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" index 61c1d7986..ec48a0c61 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/delete-organization.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" index e0b77da08..f340e2cc9 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-department.md" @@ -119,23 +119,23 @@ data = management_client.get_department( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" index 4d3c09b80..da78cbf33 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/get-parent-department.md" @@ -116,23 +116,23 @@ data = management_client.get_parent_department( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" index e85e0af6c..023d8f9aa 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-children-departments.md" @@ -133,23 +133,23 @@ data = management_client.list_children_departments( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" index 0530f59ef..9443d4375 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-department-members.md" @@ -178,7 +178,7 @@ data = management_client.list_department_members( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" index 519dc536e..ac4b0356c 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/list-organizations.md" @@ -114,22 +114,22 @@ data = management_client.list_organizations( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" index e8362171e..4d66dcc18 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/remove-department-members.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| userIds | array[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| userIds | array[] | 是 | - | 用户 ID 列表。 | `["623c20b2a062aaaaf41b17da"]` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" index 68e11cd99..af6092cda 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-department-members.md" @@ -175,7 +175,7 @@ data = management_client.search_department_members( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" index cd8aeb155..65b58be99 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-departments.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | +| keywords | string | 是 | - | 搜索关键词,如组织名称等。 | `Authing` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| withCustomData | boolean | 否 | - | 是否获取自定义数据。 | `true` | ## 示例代码 @@ -110,23 +110,23 @@ data = management_client.search_departments( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" index 964817855..38b7b2268 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/search-organizations.md" @@ -114,22 +114,22 @@ data = management_client.search_organizations( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" index 1a5ed333b..9b5e54bff 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-department.md" @@ -15,16 +15,16 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | -| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | -| leaderUserIds | array[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | -| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| name | string | 否 | - | 部门名称。 | `开发部` | -| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | -| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | -| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | +| departmentId | string | 是 | - | 部门系统 ID(为 Authing 系统自动生成,不可修改)。 | `60b49eb83fd80adb96f26e68` | +| organizationCode | string | 是 | - | 组织 Code(organizationCode)。 | `steamory` | +| leaderUserIds | array[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| code | string | 否 | - | 部门识别码。 | `6229c4deb3e4d8a20b6021ff` | +| i18n | I18nDto | 否 | - | 多语言设置。 | `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| name | string | 否 | - | 部门名称。 | `开发部` | +| departmentIdType | string | 否 | department_id | 此次调用中使用的部门 ID 的类型。 枚举值:`department_id`,`open_department_id` | `department_id` | +| parentDepartmentId | string | 否 | - | 父部门 ID。 | `6229c4deb3e4d8a20b6021ff` | +| customData | object | 否 | - | 自定义数据,传入的对象中的 key 必须先在用户池定义相关自定义字段。 | `{"icon":"https://example.com/icon"}` | ## 示例代码 @@ -125,15 +125,15 @@ data = management_client.update_department( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -160,23 +160,23 @@ data = management_client.update_department( | membersCount | number | 是 | 部门人数(仅包含直属成员)。 示例值: `11` | | hasChildren | boolean | 是 | 是否包含子部门。 示例值: `true` | | isVirtualNode | boolean | 否 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `[object Object]` | -| customData | object | 否 | 部门的扩展字段数据。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:I18nDto。 示例值: `{"name":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| customData | object | 否 | 部门的扩展字段数据。 示例值: `{"icon":"https://example.com/logo"}` | ### I18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| name | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" index 5e357b1ba..8fb35d745 100644 --- "a/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" +++ "b/docs/reference-new/sdk-v5/python/\347\273\204\347\273\207\346\234\272\346\236\204\347\256\241\347\220\206/update-organization.md" @@ -15,13 +15,13 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| organizationCode | string | 是 | - | 组织 code。 | `steamory` | -| description | string | 否 | - | 部门描述。 | `技术研发部门` | -| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | -| leaderUserIds | array[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | -| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | -| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | -| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | +| organizationCode | string | 是 | - | 组织 code。 | `steamory` | +| description | string | 否 | - | 部门描述。 | `技术研发部门` | +| openDepartmentId | string | 否 | - | 根节点自定义 ID。 | `60b49eb83fd80adb96f26e68` | +| leaderUserIds | array[] | 否 | - | 部门负责人 ID。 | `["60b49eb83fd80adb96f26e68"]` | +| i18n | OrganizationNameI18nDto | 否 | - | 多语言设置。 | `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | +| organizationNewCode | string | 否 | - | 新组织 code。 | `steamory2` | +| organizationName | string | 否 | - | 组织名称。 | `蒸汽记忆` | ## 示例代码 @@ -111,15 +111,15 @@ data = management_client.update_organization( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit @@ -143,22 +143,22 @@ data = management_client.update_organization( | leaderUserIds | array | 否 | 部门负责人 ID。 示例值: `["60b49eb83fd80adb96f26e68"]` | | membersCount | number | 是 | 部门人数。 示例值: `150` | | isVirtualNode | boolean | 是 | 是否是虚拟部门。 | -| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `[object Object]` | +| i18n | | 否 | 多语言设置。嵌套类型:OrganizationNameI18nDto。 示例值: `{"organizationName":{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}}` | ### OrganizationNameI18nDto | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `[object Object]` | +| organizationName | | 是 | 支持多语言的字段。嵌套类型:LangObject。 示例值: `{"zh-CN":{"enabled":false,"value":"中文"},"en-US":{"enabled":false,"value":"English"}}` | ### LangObject | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | -| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `[object Object]` | +| zh-CN | | 是 | 多语言的中文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"中文"}` | +| en-US | | 是 | 多语言的英文内容。嵌套类型:LangUnit。 示例值: `{"enabled":false,"value":"English"}` | ### LangUnit diff --git "a/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" "b/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" index 53cf575cc..232159753 100644 --- "a/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" +++ "b/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-data.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 | | -| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | -| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | -| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | +| list | SetCustomDataDto[] | 是 | - | 自定义数据列表。 数组长度限制:50。 | | +| targetIdentifier | string | 是 | - | 主体类型的唯一标志符。如果是用户则为用户 ID,角色为角色的 code,部门为部门的 ID。 | `userId1` | +| targetType | string | 是 | - | 主体类型,目前支持用户、角色、分组、部门。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | `USER` | +| namespace | string | 否 | - | 所属权限分组的 code,当 target_type 为角色的时候需要填写,否则可以忽略。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" "b/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" index 35d0627ae..2fd9b5720 100644 --- "a/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" +++ "b/docs/reference-new/sdk-v5/python/\350\207\252\345\256\232\344\271\211\345\255\227\346\256\265\347\256\241\347\220\206/set-custom-fields.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 | | +| list | SetCustomFieldDto[] | 是 | - | 自定义字段列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" index 9ec776a62..0f2344365 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/assign-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 目标对象。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | +| targets | TargetDto[] | 是 | - | 目标对象。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `60b49eb83fd80adb96f26e68` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" index cc11a6b16..708fd9d9a 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is manager` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `manager` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is manager` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" index 60cfd8b72..6f0c33b3a 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/create-roles-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | RoleListItem[] | 是 | - | 角色列表。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | +| list | RoleListItem[] | 是 | - | 角色列表。 数组长度限制:50。 | `[{"code":"my-role-code","namespace":"default","description":"this is description"}]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" index 12a625be0..3bb7b7fc6 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/delete-roles-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | array[] | 是 | - | 角色 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| codeList | array[] | 是 | - | 角色 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" index 550152181..6f41a3d14 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/list-role-members.md" @@ -166,7 +166,7 @@ data = management_client.list_role_members( | resetPasswordOnNextLogin | boolean | 否 | 下次登录要求重置密码。 | | departmentIds | array | 否 | 用户所属部门 ID 列表。 示例值: `["624d930c3xxxx5c08dd4986e","624d93102xxxx012f33cd2fe"]` | | identities | array | 否 | 外部身份源。嵌套类型:IdentityDto。 | -| customData | object | 否 | 用户的扩展字段数据。 示例值: `[object Object]` | +| customData | object | 否 | 用户的扩展字段数据。 示例值: `{"school":"北京大学","age":22}` | | statusChangedAt | string | 否 | 用户状态上次修改时间。 示例值: `2022-07-03T02:20:30.000Z` | diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" index 154114320..f3c02fec0 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/revoke-role.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| targets | TargetDto[] | 是 | - | 移除角色的目标。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| targets | TargetDto[] | 是 | - | 移除角色的目标。 数组长度限制:50。 | `[{"targetIdentifier":"60b49eb83fd80adb96f26e68","targetType":"USER"}]` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" index ab3287d8b..32d34a706 100644 --- "a/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" +++ "b/docs/reference-new/sdk-v5/python/\350\247\222\350\211\262\347\256\241\347\220\206/update-role.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | -| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | -| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | -| description | string | 否 | - | 角色描述。 | `this is description` | +| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | `code2` | +| code | string | 是 | - | 权限分组内角色的唯一标识符。 | `code1` | +| namespace | string | 否 | default | 所属权限分组的 code。 | `default` | +| description | string | 否 | - | 角色描述。 | `this is description` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" index 5d7f1246d..84fd812f1 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/authorize-resources.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | AuthorizeResourceItem[] | 是 | - | 授权资源列表。 数组长度限制:10。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -80,7 +80,7 @@ data = management_client.authorize_resources( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | targetType | string | 是 | 目标对象类型。 枚举值:`USER`,`ROLE`,`GROUP`,`DEPARTMENT` | -| targetIdentifiers | array | 是 | 目标对象唯一标志符。 示例值: `["userId1","userId2"]` | +| targetIdentifiers | array | 是 | 目标对象唯一标志符。数组长度限制:100。 示例值: `["userId1","userId2"]` | | resources | array | 是 | 授权的资源列表。嵌套类型:ResourceItemDto。 | @@ -89,7 +89,7 @@ data = management_client.authorize_resources( | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | -| actions | array | 是 | 资源定义的操作类型。 示例值: `["ecs:Stop","ecs:Start"]` | +| actions | array | 是 | 资源定义的操作类型。数组长度限制:50。 示例值: `["ecs:Stop","ecs:Start"]` | | resourceType | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" index b9bd36f94..ba673298f 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespace.md" @@ -15,9 +15,9 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" index 2e1608ef9..3a534d6c2 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 | | +| list | CreateNamespacesBatchItemDto[] | 是 | - | 权限分组列表。 数组长度限制:50。 | | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" index 723ff3f04..23a8aff0a 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 是 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -98,7 +98,7 @@ data = management_client.create_resource( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" index 93f248f09..7f315aba8 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/create-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 | | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| list | CreateResourceBatchItemDto[] | 是 | - | 资源列表。 数组长度限制:50。 | | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 @@ -83,7 +83,7 @@ data = management_client.create_resources_batch( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" index 5178cb1b5..73bed00e9 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespace.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" index efb7ac86d..44e275c15 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | array[] | 是 | - | 权限分组 code 列表。 | `["code1","code2"]` | +| codeList | array[] | 是 | - | 权限分组 code 列表。 数组长度限制:10。 | `["code1","code2"]` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" index 0bd298a3a..502fa8085 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resource.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" index c3f056a60..227dadc83 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/delete-resources-batch.md" @@ -15,8 +15,8 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | array[] | 是 | - | 资源 code 列表。 | `["code1","code2"]` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| codeList | array[] | 是 | - | 资源 code 列表。 数组长度限制:50。 | `["code1","code2"]` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" index 99a4c40e3..0fc59d5fe 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-authorized-resources.md" @@ -19,7 +19,7 @@ | targetIdentifier | string | 是 | - | 目标对象唯一标志符。 | `userId1` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | | resourceType | string | 否 | - | 限定资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `DATA` | -| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。 | | +| resourceList | string[] | 否 | - | 限定查询的资源列表,如果指定,只会返回所指定的资源列表。。数组长度限制:50。 | | | withDenied | boolean | 否 | - | 是否获取被拒绝的资源。 | | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" index c870f2229..8e77bc507 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-namespaces-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `code1,code2` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" index 956eb23d2..a9f8b4651 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resource.md" @@ -81,7 +81,7 @@ data = management_client.get_resource( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" index 8dbbfe990..ac7e1b48d 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/get-resources-batch.md" @@ -15,7 +15,7 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。 | `code1,code2` | +| codeList | string[] | 是 | - | 资源 code 列表,批量可以使用逗号分隔。数组长度限制:50。 | `["code1","code2"]` | | namespace | string | 否 | - | 所属权限分组的 code。 | `default` | @@ -81,7 +81,7 @@ data = management_client.get_resources_batch( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" index b0cacc7f8..80c334001 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/is-action-allowed.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | -| resource | string | 是 | - | 资源标识符。 | `ecs:1` | -| userId | string | 是 | - | 用户 ID。 | `userId1` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| action | string | 是 | - | 资源对应的操作。 | `ecs:Start` | +| resource | string | 是 | - | 资源标识符。 | `ecs:1` | +| userId | string | 是 | - | 用户 ID。 | `userId1` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" index f13949ec4..178aeb02b 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/list-resources.md" @@ -103,7 +103,7 @@ data = management_client.list_resources( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" index ca0a32361..f2c0f73a3 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-namespace.md" @@ -15,10 +15,10 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | -| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | -| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | -| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | +| code | string | 是 | - | 权限分组唯一标志符。 | `my-namespace` | +| description | string | 否 | - | 权限分组描述信息。 | `我的权限分组描述` | +| name | string | 否 | - | 权限分组名称。 | `我的权限分组` | +| newCode | string | 否 | - | 权限分组新的唯一标志符。 | `my-new-namespace` | ## 示例代码 diff --git "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" index 04b07b6dc..4a8d2da38 100644 --- "a/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" +++ "b/docs/reference-new/sdk-v5/python/\350\256\277\351\227\256\346\216\247\345\210\266\347\256\241\347\220\206/update-resource.md" @@ -15,12 +15,12 @@ | 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | | ---- | ---- | ---- | ---- | ---- | ---- | -| code | string | 是 | - | 资源唯一标志符。 | `ecs` | -| description | string | 否 | - | 资源描述。 | `服务器` | -| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | -| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | -| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | -| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | +| code | string | 是 | - | 资源唯一标志符。 | `ecs` | +| description | string | 否 | - | 资源描述。 | `服务器` | +| actions | ResourceAction[] | 否 | - | 资源定义的操作类型。 数组长度限制:100。 | `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| apiIdentifier | string | 否 | - | API 资源的 URL 标识。 | `https://my-awesome-api.com/api` | +| namespace | string | 否 | - | 所属权限分组的 code。 | `default` | +| type | string | 否 | - | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | `API` | ## 示例代码 @@ -98,7 +98,7 @@ data = management_client.update_resource( | code | string | 是 | 资源唯一标志符。 示例值: `ecs` | | description | string | 否 | 资源描述。 示例值: `服务器` | | type | string | 是 | 资源类型,如数据、API、按钮、菜单。 枚举值:`DATA`,`API`,`MENU`,`BUTTON` | -| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | +| actions | array | 否 | 资源定义的操作类型。嵌套类型:ResourceAction。数组长度限制:100。 示例值: `[{"name":"ecs:Start","description":"启动 ECS 服务器"},{"name":"ecs:Stop","description":"停止 ECS 服务器"}]` | | apiIdentifier | string | 否 | API 资源的 URL 标识。 示例值: `https://my-awesome-api.com/api` | | namespace | string | 否 | 所属权限分组的 code。 示例值: `default` | diff --git a/package.json b/package.json index d3d3ade1c..c82ae68b8 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,9 @@ "dayjs": "^1.10.4", "markdown-it-include": "^2.0.0", "node-sass": "npm:dart-sass@^1.25.0", + "qrcode": "^1.5.1", "v-tooltip": "^2.1.3", + "vue-clipboard2": "^0.3.3", "vue-notification": "^1.3.20", "vue-pagination-2": "^3.0.8", "vue-select": "^3.11.2",