Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add manage token docs and manage datasource and permission docs #31

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions docs/.vuepress/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down Expand Up @@ -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: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

### 示例代码

```c#
```csharp
using System.Threading.Tasks;
using Authing.CSharp.SDK.Models.Authentication;
using Authing.CSharp.SDK.Services;
Expand Down Expand Up @@ -97,7 +97,7 @@ namespace ConsoleApplication

### 示例代码

```c#
```csharp
using System.Threading.Tasks;
using Authing.CSharp.SDK.Models.Authentication;
using Authing.CSharp.SDK.Services;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -109,7 +109,7 @@ namespace ConsoleApplication

### 示例代码

```C#
```csharp
using System.Threading.Tasks;
using Authing.CSharp.SDK.Models.Authentication;
using Authing.CSharp.SDK.Services;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## 示例代码

```C#
```csharp
using System.Threading.Tasks;
using Authing.CSharp.SDK.Models.Authentication;
using Authing.CSharp.SDK.Services;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,19 @@

数据策略创建主体授权,通过授权主体和数据策略进行相互授权。


## 方法名称

`ManagementClient.AuthorizeDataPolicies`

## 请求参数

| 名称 | 类型 | <div style="width:80px">是否必填</div> | <div style="width:60px">默认值</div> | <div style="width:300px">描述</div> | <div style="width:200px">示例值</div> |
| ---- | ---- | ---- | ---- | ---- | ---- |
| targetList | <a href="#SubjectDto">SubjectDto[]</a> | 是 | - | 数据权限列表,每个策略下所有的数据权限 | |
| policyIds | string[] | 是 | - | 数据策略 id 列表 数组长度限制:50。 | `["6301cexxxxxxxxxx27478","63123cexxxxxxxxxx2123101"]` |
类型: `CreateAuthorizeDataPolicyDto`

| 名称 | 类型 | <div style="width:80px">是否必填</div> | <div style="width:60px">默认值</div> | <div style="width:300px">描述</div> | <div style="width:200px">示例值</div> |
|------------|----------------------------------------|------------------------------------|-----------------------------------|-----------------------------------|--------------------------------------------------------|
| targetList | <a href="#SubjectDto">SubjectDto[]</a> | 是 | - | 数据权限列表,每个策略下所有的数据权限 | |
| policyIds | array | 是 | - | 数据策略 id 列表 数组长度限制:50。 | `["6301cexxxxxxxxxx27478","63123cexxxxxxxxxx2123101"]` |



Expand All @@ -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
Expand All @@ -57,20 +55,21 @@ namespace ConsoleManagement

CommonResponseDto result = await managementClient.AuthorizeDataPolicies(new CreateAuthorizeDataPolicyDto
{
PolicyIds = new List<string> { "POLICYID" },
PolicyIds = new List<string> { "POLICY_ID" },
TargetList = new List<SubjectDto>
{
new SubjectDto
{
Id="USERID",
Name="USERNAME",
Id="USER_ID",
Name="USER_NAME",
Type=SubjectDto.type.USER
}
}
});
}
}
}

```


Expand Down Expand Up @@ -110,4 +109,3 @@ namespace ConsoleManagement
| type | string | 是 | 主体类型,包括 USER、GROUP、ROLE、ORG 四种类型 | USER |
| name | string | 否 | 主体名称,包含用户名称、用户组名称、角色名称、组织机构名称 | `用户名称` |


Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,18 @@

通过数据策略名称查询用户池内是否存在。


## 方法名称

`ManagementClient.CheckDataPolicyExists`

## 请求参数

| 名称 | 类型 | <div style="width:80px">是否必填</div> | <div style="width:60px">默认值</div> | <div style="width:300px">描述</div> | <div style="width:200px">示例值</div> |
| ---- | ---- | ---- | ---- | ---- | ---- |
| policyName | string | 是 | - | 数据策略名称,用户池唯一 | `示例数据策略名称` |
类型: `CheckDataPolicyExistsDto`

| 名称 | 类型 | <div style="width:80px">是否必填</div> | <div style="width:60px">默认值</div> | <div style="width:300px">描述</div> | <div style="width:200px">示例值</div> |
|------------|--------|------------------------------------|-----------------------------------|-----------------------------------|------------------------------------|
| policyName | string | 是 | - | 数据策略名称,用户池唯一 | `示例数据策略名称` |



Expand All @@ -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
Expand All @@ -61,6 +59,7 @@ namespace ConsoleManagement
}
}
}

```


Expand Down Expand Up @@ -104,4 +103,3 @@ namespace ConsoleManagement
| isValid | boolean | 是 | 数据策略名称校验是否有效 | ` false` |
| message | string | 否 | 数据策略名称校验失败提示信息,如果校验成功, message 不返回 | ` data Policy name already exist` |


Loading