diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js index 85fdf914..a5f08dc9 100755 --- a/docs/.vuepress/sidebar.js +++ b/docs/.vuepress/sidebar.js @@ -6183,6 +6183,23 @@ const zhCnNavBar = { } ] }, + { + "title": "管理 Token", + "children": [ + { + "title": "获取 Token", + "path": "/reference/sdk/csharp/authentication/管理-token/get-access-token.md" + }, + { + "title": "校验 Token", + "path": "/reference/sdk/csharp/authentication/管理-token/introspect-token.md" + }, + { + "title": "撤销 Token", + "path": "/reference/sdk/csharp/authentication/管理-token/revoke-token.md" + } + ] + }, { title: '注册', children: [ @@ -6847,6 +6864,159 @@ const zhCnNavBar = { } ] }, + { + "title": "管理数据资源与权限", + "children": [ + { + "title": "创建权限空间", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-permission-namespace" + }, + { + "title": "批量创建权限空间", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-permission-namespaces-batch" + }, + { + "title": "获取权限空间详情", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-permission-namespace" + }, + { + "title": "批量获取权限空间详情列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-permission-namespaces-batch" + }, + { + "title": "分页获取权限空间列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-permission-namespaces" + }, + { + "title": "修改权限空间", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/update-permission-namespace" + }, + { + "title": "删除权限空间", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/delete-permission-namespace" + }, + { + "title": "批量删除权限空间", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/delete-permission-namespaces-batch" + }, + { + "title": "校验权限空间 Code 或者名称是否可用", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-permission-namespace-exists" + }, + { + "title": "分页查询权限空间下所有的角色列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-permission-namespace-roles" + }, + { + "title": "创建数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-data-resource" + }, + { + "title": "创建字符串数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-string-data-resource" + }, + { + "title": "创建数组数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-array-data-resource" + }, + { + "title": "创建树数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-tree-data-resource" + }, + { + "title": "获取数据资源列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-data-resources" + }, + { + "title": "获取数据资源信息", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-data-resource" + }, + { + "title": "修改数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/update-data-resource" + }, + { + "title": "删除数据资源", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/delete-data-resource" + }, + { + "title": "检查数据资源名称或者 Code 是否可用", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-data-resource-exists" + }, + { + "title": "创建数据策略", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/create-data-policy" + }, + { + "title": "获取数据策略列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-data-policies" + }, + { + "title": "获取数据策略简略信息列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-simple-data-policies" + }, + { + "title": "获取数据策略信息", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-data-policy" + }, + { + "title": "修改数据策略", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/update-data-policy" + }, + { + "title": "删除数据策略", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/delete-data-policy" + }, + { + "title": "校验数据策略名称是否存在", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-data-policy-exists" + }, + { + "title": "获取数据策略下所有的授权主体的信息", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-data-policy-targets" + }, + { + "title": "授权数据策略", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/authorize-data-policies" + }, + { + "title": "撤销数据策略", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/revoke-data-policy" + }, + { + "title": "获取用户权限列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-user-permission-list" + }, + { + "title": "判断用户权限", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-permission" + }, + { + "title": "判断外部用户权限", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-external-user-permission" + }, + { + "title": "获取用户指定资源权限列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-user-resource-permission-list" + }, + { + "title": "获取资源被授权的用户列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/list-resource-targets" + }, + { + "title": "获取用户授权资源的结构列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-user-resource-struct" + }, + { + "title": "获取外部用户授权资源的结构列表", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/get-external-user-resource-struct" + }, + { + "title": "判断用户在树资源同层级资源下的权限", + "path": "/reference/sdk/csharp/management/管理数据资源与权限/check-user-same-level-permission" + }, + ] + }, { title: '管理应用', children: [ diff --git "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/get-access-token.md" "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/get-access-token.md" index d96cc230..926aafa0 100644 --- "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/get-access-token.md" +++ "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/get-access-token.md" @@ -45,7 +45,7 @@ ### 示例代码 -```c# +```csharp using System.Threading.Tasks; using Authing.CSharp.SDK.Models.Authentication; using Authing.CSharp.SDK.Services; @@ -97,7 +97,7 @@ namespace ConsoleApplication ### 示例代码 -```c# +```csharp using System.Threading.Tasks; using Authing.CSharp.SDK.Models.Authentication; using Authing.CSharp.SDK.Services; diff --git "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/introspect-token.md" "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/introspect-token.md" index 2d9e7b72..b25c7f43 100644 --- "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/introspect-token.md" +++ "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/introspect-token.md" @@ -24,7 +24,7 @@ Authing C# SDK 提供两种校验 Token 的方式:在线校验和本地校验 ### 示例代码 -```C# +```csharp using System.Threading.Tasks; using Authing.CSharp.SDK.Models.Authentication; using Authing.CSharp.SDK.Services; @@ -109,7 +109,7 @@ namespace ConsoleApplication ### 示例代码 -```C# +```csharp using System.Threading.Tasks; using Authing.CSharp.SDK.Models.Authentication; using Authing.CSharp.SDK.Services; diff --git "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/revoke-token.md" "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/revoke-token.md" index 96490786..26141cbe 100644 --- "a/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/revoke-token.md" +++ "b/docs/reference/sdk/csharp/authentication/\347\256\241\347\220\206-token/revoke-token.md" @@ -20,7 +20,7 @@ ## 示例代码 -```C# +```csharp using System.Threading.Tasks; using Authing.CSharp.SDK.Models.Authentication; using Authing.CSharp.SDK.Services; diff --git "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/authorize-data-policies.md" "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/authorize-data-policies.md" index e52cfe05..614c6ad5 100644 --- "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/authorize-data-policies.md" +++ "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/authorize-data-policies.md" @@ -11,16 +11,19 @@ 数据策略创建主体授权,通过授权主体和数据策略进行相互授权。 + ## 方法名称 `ManagementClient.AuthorizeDataPolicies` ## 请求参数 -| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| -| ---- | ---- | ---- | ---- | ---- | ---- | -| targetList | SubjectDto[] | 是 | - | 数据权限列表,每个策略下所有的数据权限 | | -| policyIds | string[] | 是 | - | 数据策略 id 列表 数组长度限制:50。 | `["6301cexxxxxxxxxx27478","63123cexxxxxxxxxx2123101"]` | +类型: `CreateAuthorizeDataPolicyDto` + +| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| +|------------|----------------------------------------|------------------------------------|-----------------------------------|-----------------------------------|--------------------------------------------------------| +| targetList | SubjectDto[] | 是 | - | 数据权限列表,每个策略下所有的数据权限 | | +| policyIds | array | 是 | - | 数据策略 id 列表 数组长度限制:50。 | `["6301cexxxxxxxxxx27478","63123cexxxxxxxxxx2123101"]` | @@ -29,21 +32,16 @@ ```csharp using Authing.CSharp.SDK.Services; -using System; using System.Threading.Tasks; using Authing.CSharp.SDK.Models; using System.Collections.Generic; +using System.Linq; namespace ConsoleManagement { public class Program { - static void Main(string[] args) - { - MainAsync().GetAwaiter().GetResult(); - } - - private static async Task MainAsync() + static async Task Main(string[] args) { // 设置初始化参数 ManagementClientOptions clientOptions = new ManagementClientOptions @@ -57,13 +55,13 @@ namespace ConsoleManagement CommonResponseDto result = await managementClient.AuthorizeDataPolicies(new CreateAuthorizeDataPolicyDto { - PolicyIds = new List { "POLICYID" }, + PolicyIds = new List { "POLICY_ID" }, TargetList = new List { new SubjectDto { - Id="USERID", - Name="USERNAME", + Id="USER_ID", + Name="USER_NAME", Type=SubjectDto.type.USER } } @@ -71,6 +69,7 @@ namespace ConsoleManagement } } } + ``` @@ -110,4 +109,3 @@ namespace ConsoleManagement | type | string | 是 | 主体类型,包括 USER、GROUP、ROLE、ORG 四种类型 | USER | | name | string | 否 | 主体名称,包含用户名称、用户组名称、角色名称、组织机构名称 | `用户名称` | - diff --git "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-policy-exists.md" "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-policy-exists.md" index e0279f02..7b146341 100644 --- "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-policy-exists.md" +++ "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-policy-exists.md" @@ -11,15 +11,18 @@ 通过数据策略名称查询用户池内是否存在。 + ## 方法名称 `ManagementClient.CheckDataPolicyExists` ## 请求参数 -| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| -| ---- | ---- | ---- | ---- | ---- | ---- | - | policyName | string | 是 | - | 数据策略名称,用户池唯一 | `示例数据策略名称` | +类型: `CheckDataPolicyExistsDto` + +| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| +|------------|--------|------------------------------------|-----------------------------------|-----------------------------------|------------------------------------| + | policyName | string | 是 | - | 数据策略名称,用户池唯一 | `示例数据策略名称` | @@ -28,21 +31,16 @@ ```csharp using Authing.CSharp.SDK.Services; -using System; using System.Threading.Tasks; using Authing.CSharp.SDK.Models; using System.Collections.Generic; +using System.Linq; namespace ConsoleManagement { public class Program { - static void Main(string[] args) - { - MainAsync().GetAwaiter().GetResult(); - } - - private static async Task MainAsync() + static async Task Main(string[] args) { // 设置初始化参数 ManagementClientOptions clientOptions = new ManagementClientOptions @@ -61,6 +59,7 @@ namespace ConsoleManagement } } } + ``` @@ -104,4 +103,3 @@ namespace ConsoleManagement | isValid | boolean | 是 | 数据策略名称校验是否有效 | ` false` | | message | string | 否 | 数据策略名称校验失败提示信息,如果校验成功, message 不返回 | ` data Policy name already exist` | - diff --git "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-resource-exists.md" "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-resource-exists.md" index 4ddda05c..89fc0f05 100644 --- "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-resource-exists.md" +++ "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-data-resource-exists.md" @@ -84,7 +84,7 @@ } } ``` - + ## 方法名称 @@ -92,11 +92,13 @@ ## 请求参数 -| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| -| ---- | ---- | ---- | ---- | ---- | ---- | - | namespaceCode | string | 是 | - | 数据资源所属的权限空间 Code | `examplePermissionNamespace` | - | resourceName | string | 否 | - | 数据资源名称,权限空间内唯一 | `示例数据资源名称` | - | resourceCode | string | 否 | - | 数据资源 Code,权限空间内唯一 | `dataResourceTestCode` | +类型: `CheckDataResourceExistsDto` + +| 名称 | 类型 |
是否必填
|
默认值
|
描述
|
示例值
| +|---------------|--------|------------------------------------|-----------------------------------|-----------------------------------|------------------------------------| + | namespaceCode | string | 是 | - | 数据资源所属的权限空间 Code | `examplePermissionNamespace` | + | resourceName | string | 否 | - | 数据资源名称,权限空间内唯一 | `示例数据资源名称` | + | resourceCode | string | 否 | - | 数据资源 Code,权限空间内唯一 | `dataResourceTestCode` | @@ -105,21 +107,16 @@ ```csharp using Authing.CSharp.SDK.Services; -using System; using System.Threading.Tasks; using Authing.CSharp.SDK.Models; using System.Collections.Generic; +using System.Linq; namespace ConsoleManagement { public class Program { - static void Main(string[] args) - { - MainAsync().GetAwaiter().GetResult(); - } - - private static async Task MainAsync() + static async Task Main(string[] args) { // 设置初始化参数 ManagementClientOptions clientOptions = new ManagementClientOptions @@ -133,13 +130,20 @@ namespace ConsoleManagement CheckParamsDataResourceResponseDto result = await managementClient.CheckDataResourceExists(new CheckDataResourceExistsDto { - NamespaceCode = "examplePermissionNamespace", - ResourceName = "test" + NamespaceCode = "examplePermissionNamespace", + ResourceCode = "treeResourceCode" }); + CheckParamsDataResourceResponseDto result1 = await managementClient.CheckDataResourceExists(new CheckDataResourceExistsDto + { + NamespaceCode = "examplePermissionNamespace", + ResourceName = "示例树数据资源名称" + }); + } } } + ``` @@ -183,4 +187,3 @@ namespace ConsoleManagement | isValid | boolean | 是 | 数据资源名称或者 Code 校验是否有效 | `false` | | message | string | 否 | 数据资源名称或者 Code 校验失败提示信息,如果校验成功, message 不返回 | `data resource name already exist` | - diff --git "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-external-user-permission.md" "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-external-user-permission.md" index 03fe6079..61f3d166 100644 --- "a/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-external-user-permission.md" +++ "b/docs/reference/sdk/csharp/management/\347\256\241\347\220\206\346\225\260\346\215\256\350\265\204\346\272\220\344\270\216\346\235\203\351\231\220/check-external-user-permission.md" @@ -1,4 +1,4 @@ -# 判断外部用户权限 +~~# 判断外部用户权限