From 7632f6353d875fbeca501abf1398bab95cc8d45a Mon Sep 17 00:00:00 2001 From: qidong Date: Tue, 7 Mar 2023 16:16:10 +0800 Subject: [PATCH 1/4] feat: add csharp token api doc --- docs/.vuepress/sidebar.js | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js index 85fdf914..82013057 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: [ From fc957e745714678582b6443fa9a52b0d310c892f Mon Sep 17 00:00:00 2001 From: qidong Date: Tue, 7 Mar 2023 17:05:02 +0800 Subject: [PATCH 2/4] fix: fix csharp api doc error --- .../\347\256\241\347\220\206-token/get-access-token.md" | 4 ++-- .../\347\256\241\347\220\206-token/introspect-token.md" | 4 ++-- .../\347\256\241\347\220\206-token/revoke-token.md" | 2 +- version.txt | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) 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/version.txt b/version.txt index d34586a1..41ba552b 100755 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.0.25 \ No newline at end of file +0.0.26 \ No newline at end of file From 11bf374e030dd89ba0b5059faed04d66c744aa92 Mon Sep 17 00:00:00 2001 From: qidong Date: Wed, 8 Mar 2023 19:45:30 +0800 Subject: [PATCH 3/4] =?UTF-8?q?fix=EF=BC=9A=20=E4=BF=AE=E5=A4=8D=E7=AE=A1?= =?UTF-8?q?=E7=90=86=E6=95=B0=E6=8D=AE=E8=B5=84=E6=BA=90=E5=92=8C=E6=9D=83?= =?UTF-8?q?=E9=99=90=E7=9A=84=E6=96=87=E6=A1=A3=E9=94=99=E8=AF=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../authorize-data-policies.md" | 28 +- .../check-data-policy-exists.md" | 20 +- .../check-data-resource-exists.md" | 35 +- .../check-external-user-permission.md" | 103 +++--- .../check-permission-namespace-exists.md" | 33 +- .../check-permission.md" | 102 +++--- .../check-user-same-level-permission.md" | 140 ++++---- .../create-array-data-resource.md" | 31 +- .../create-data-policy.md" | 27 +- .../create-data-resource.md" | 59 ++-- .../create-permission-namespace.md" | 31 +- .../create-permission-namespaces-batch.md" | 48 +-- .../create-string-data-resource.md" | 32 +- .../create-tree-data-resource.md" | 32 +- .../delete-data-policy.md" | 23 +- .../delete-data-resource.md" | 27 +- .../delete-permission-namespace.md" | 23 +- .../delete-permission-namespaces-batch.md" | 26 +- .../get-data-policy.md" | 23 +- .../get-data-resource.md" | 30 +- .../get-external-user-resource-struct.md" | 321 +++++++++++++----- .../get-permission-namespace.md" | 28 +- .../get-permission-namespaces-batch.md" | 24 +- .../get-user-permission-list.md" | 277 ++++++++------- .../get-user-resource-permission-list.md" | 72 ++-- .../get-user-resource-struct.md" | 315 ++++++++++++----- .../list-data-policies.md" | 25 +- .../list-data-policy-targets.md" | 36 +- .../list-data-resources.md" | 32 +- .../list-permission-namespace-roles.md" | 29 +- .../list-permission-namespaces.md" | 27 +- .../list-resource-targets.md" | 92 ++--- .../list-simple-data-policies.md" | 28 +- .../revoke-data-policy.md" | 31 +- .../update-data-policy.md" | 73 ++-- .../update-data-resource.md" | 43 ++- .../update-permission-namespace.md" | 32 +- 37 files changed, 1329 insertions(+), 1029 deletions(-) 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 @@ -# 判断外部用户权限 +~~# 判断外部用户权限