management

package
v3.0.19 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 2, 2025 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAccessToken 

func GetAccessToken(client *ManagementClient) (string, error)

func QueryAccessToken 

func QueryAccessToken(client *ManagementClient) (*dto.GetManagementTokenRespDto, error)

Types

type JwtClaims 

type JwtClaims struct {
	*jwt.StandardClaims
	//用户编号
	UID      string
	Username string
}

type ManagementClient 

type ManagementClient struct {
	HttpClient *http.Client
	// contains filtered or unexported fields
}

func NewManagementClient 

func NewManagementClient(options *ManagementClientOptions) (*ManagementClient, error)

func (*ManagementClient) Add added in v3.0.14 

func (client *ManagementClient) Add(reqDto *dto.IpListCreateDto) *dto.CommonResponseDto

* @summary 创建 ip 名单 * @description 创建 ip 名单 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) AddDepartmentMembers 

func (client *ManagementClient) AddDepartmentMembers(reqDto *dto.AddDepartmentMembersReqDto) *dto.IsSuccessRespDto

* @summary 部门下添加成员 * @description 通过部门 ID、组织 code，添加部门下成员。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AddGroupMembers 

func (client *ManagementClient) AddGroupMembers(reqDto *dto.AddGroupMembersReqDto) *dto.IsSuccessRespDto

* @summary 添加分组成员 * @description 添加分组成员，成员以用户 ID 数组形式传递。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AddRiskListPolicy added in v3.0.14 

func (client *ManagementClient) AddRiskListPolicy(reqDto *dto.RiskListPolicyCreateDto) *dto.CommonResponseDto

* @summary 创建风险策略 * @description 创建风险策略 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) AddTenantDepartmentMembers added in v3.0.14 

func (client *ManagementClient) AddTenantDepartmentMembers(reqDto *dto.AddTenantDepartmentMembersReqDto) *dto.IsSuccessRespDto

* @summary 租户部门下添加成员 * @description 通过部门 ID、组织 code，添加部门下成员。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AddTenantUsers added in v3.0.14 

func (client *ManagementClient) AddTenantUsers(reqDto *dto.AddTenantUsersDto) *dto.CommonResponseDto

* @summary 添加租户成员 * @description 根据用户 ID 批量添加租户成员 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) AddUser added in v3.0.14 

func (client *ManagementClient) AddUser(reqDto *dto.UserListCreateDto) *dto.CommonResponseDto

* @summary 创建用户名单 * @description 创建用户名单 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) AddWhitelist added in v3.0.14 

func (client *ManagementClient) AddWhitelist(reqDto *dto.AddWhitelistDto) *dto.WhitelistListRespDto

* @summary 创建注册白名单 * @description 你需要指定注册白名单类型以及数据，来进行创建 * @param requestBody * @returns WhitelistListRespDto

func (*ManagementClient) AssignAsaAccount added in v3.0.4 

func (client *ManagementClient) AssignAsaAccount(reqDto *dto.AssignAsaAccountsDto) *dto.IsSuccessRespDto

* @summary 分配 ASA 账号 * @description 分配 ASA 账号给用户、组织、分组或角色 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AssignRole 

func (client *ManagementClient) AssignRole(reqDto *dto.AssignRoleDto) *dto.IsSuccessRespDto

* @summary 单个角色批量授权 * @description 通过权限分组内角色 code，分配角色，被分配者可以是用户或部门。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AssignRoleBatch added in v3.0.14 

func (client *ManagementClient) AssignRoleBatch(reqDto *dto.AssignRoleBatchDto) *dto.IsSuccessRespDto

* @summary 批量分配角色 * @description 批量分配角色，被分配者可以是用户，可以是部门 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AssociateTenantResource 

func (client *ManagementClient) AssociateTenantResource(reqDto *dto.AssociateTenantResourceDto) *dto.IsSuccessRespDto

* @summary 关联/取消关联应用资源到租户 * @description 通过资源唯一标识以及权限分组，关联或取消关联资源到租户 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AuthorizeApplicationAccess 

func (client *ManagementClient) AuthorizeApplicationAccess(reqDto *dto.AuthorizeApplicationAccessDto) *dto.IsSuccessRespDto

* @summary 授权应用访问权限 * @description 给用户、分组、组织或角色授权应用访问权限，如果用户、分组、组织或角色不存在，则跳过，进行下一步授权，不返回报错 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) AuthorizeDataPolicies added in v3.0.4 

func (client *ManagementClient) AuthorizeDataPolicies(reqDto *dto.CreateAuthorizeDataPolicyDto) *dto.CommonResponseDto

* @summary 授权数据策略 * @description 数据策略创建主体授权，通过授权主体和数据策略进行相互授权。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) AuthorizeResources 

func (client *ManagementClient) AuthorizeResources(reqDto *dto.AuthorizeResourcesDto) *dto.IsSuccessRespDto

* @summary 授权资源 * @description 将一个/多个资源授权给用户、角色、分组、组织机构等主体，且可以分别指定不同的操作权限。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) BatchDeleteCommonResource added in v3.0.14 

func (client *ManagementClient) BatchDeleteCommonResource(reqDto *dto.DeleteCommonResourcesBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除资源 * @description 通过资源id批量删除资源 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) BindPublicAccountOfRoles added in v3.0.14 

func (client *ManagementClient) BindPublicAccountOfRoles(reqDto *dto.SetUserRolesDto) *dto.IsSuccessRespDto

* @summary 公共账号绑定批量角色 * @description 公共账号绑定批量角色 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) BindUsersPublicAccount added in v3.0.14 

func (client *ManagementClient) BindUsersPublicAccount(reqDto *dto.SetPublicAccountBatchReqDto) *dto.IsSuccessRespDto

* @summary 公共账号绑定批量用户 * @description 使用公共账号绑定批量用户 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CancelSyncRiskOperation 

func (client *ManagementClient) CancelSyncRiskOperation(reqDto *dto.CancelSyncRiskOperationDto) *dto.CancelSyncRiskOperationsRespDto

* @summary 取消同步风险操作 * @description 取消同步风险操作 * @param requestBody * @returns CancelSyncRiskOperationsRespDto

func (*ManagementClient) Capture added in v3.0.14 

func (client *ManagementClient) Capture(reqDto *dto.CreateUEBADto) *dto.CreateUEBARespDto

* @summary UEBA 上传 * @description UEBA 上传 * @param requestBody * @returns CreateUEBARespDto

func (*ManagementClient) ChangeExtIdpConnAssociationState 

func (client *ManagementClient) ChangeExtIdpConnAssociationState(reqDto *dto.ChangeExtIdpAssociationStateDto) *dto.IsSuccessRespDto

* @summary 租户关联身份源 * @description 租户可以关联或取消关联身份源连接。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) ChangeExtIdpConnState 

func (client *ManagementClient) ChangeExtIdpConnState(reqDto *dto.ChangeExtIdpConnStateDto) *dto.IsSuccessRespDto

* @summary 身份源连接开关 * @description 身份源连接开关，可以打开或关闭身份源连接。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) ChangeIntoPublicAccount added in v3.0.14 

func (client *ManagementClient) ChangeIntoPublicAccount(reqDto *dto.CreatePublicAccountFromUserDto) *dto.CommonResponseDto

* @summary 个人账号转换为公共账号 * @description 通过用户 ID，把个人账号转换为公共账号。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ChangeUserpoolTenanExtIdpConnState added in v3.0.7 

func (client *ManagementClient) ChangeUserpoolTenanExtIdpConnState(reqDto *dto.ChangeUserPoolTenantExtIdpConnDto) *dto.IsSuccessRespDto

* @summary 设置用户池多租户身份源连接 * @description 设置用户池多租户身份源连接，支持同时设置多个身份源连接，支持设置连接和取消连接 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CheckDataPolicyExists added in v3.0.4 

func (client *ManagementClient) CheckDataPolicyExists(reqDto *dto.CheckDataPolicyExistsDto) *dto.CheckParamsDataPolicyResponseDto

* @summary 校验数据策略名称是否有效 * @description 通过数据策略名称查询用户池内是否有效。 * @param policyName 数据策略名称，用户池唯一 * @returns CheckParamsDataPolicyResponseDto

func (*ManagementClient) CheckDataResourceExists added in v3.0.4 

func (client *ManagementClient) CheckDataResourceExists(reqDto *dto.CheckDataResourceExistsDto) *dto.CheckParamsDataResourceResponseDto
  • @summary 检查数据资源名称或者 Code 是否可用
  • @description 检查数据资源名称或者 Code 在权限空间内是否有效,通过数据资源名称或者数据资源 Code 以及所属权限空间 Code,判断在指定的权限空间内是否可用。 *
  • ### 数据资源 Code 有效示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceCode": "test"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 0,
  • "data": {
  • "isValid": "true"
  • }
  • }
  • ``` *
  • ### 数据资源名称有效示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "test"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 0,
  • "data": {
  • "isValid": "true"
  • }
  • }
  • ``` *
  • ### 数据资源 Code 无效示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceCode": "test"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 0,
  • "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  • "data": {
  • "isValid": "false",
  • "message": "data resource code already exist"
  • }
  • }
  • ``` *
  • @param namespaceCode 数据资源所属的权限空间 Code
  • @param resourceName 数据资源名称, 权限空间内唯一
  • @param resourceCode 数据资源 Code, 权限空间内唯一
  • @returns CheckParamsDataResourceResponseDto

func (*ManagementClient) CheckDomainAvailable 

func (client *ManagementClient) CheckDomainAvailable(reqDto *dto.CheckDomainAvailable) *dto.CheckDomainAvailableSecretRespDto

* @summary 检测域名是否可用 * @description 检测域名是否可用于创建新应用或更新应用域名 * @param requestBody * @returns CheckDomainAvailableSecretRespDto

func (*ManagementClient) CheckExternalUserPermission added in v3.0.4 

func (client *ManagementClient) CheckExternalUserPermission(reqDto *dto.CheckExternalUserPermissionDto) *dto.CheckExternalUserPermissionRespDto
  • @summary 判断外部用户权限
  • @description
  • ## 描述
  • 当你的用户是外部用户，需要判断其是否拥有某资源的某一权限时，可以使用此接口，通过`externalId`来传递用户的 ID *
  • @param requestBody
  • @returns CheckExternalUserPermissionRespDto

func (*ManagementClient) CheckParamsNamespace added in v3.0.4 

func (client *ManagementClient) CheckParamsNamespace(reqDto *dto.CheckRoleParamsDto) *dto.RoleCheckParamsRespDto

* @summary 校验角色 Code 或者名称是否可用 * @description 通过用户池 ID、权限空间 Code和角色 Code,或者用户池 ID、权限空间名称和角色名称查询是否可用。 * @param requestBody * @returns RoleCheckParamsRespDto

func (*ManagementClient) CheckPermission added in v3.0.4 

func (client *ManagementClient) CheckPermission(reqDto *dto.CheckPermissionDto) *dto.CheckPermissionRespDto
  • @summary 判断用户权限（重点）
  • @description
  • ## 描述
  • 当你需要判断用户是否拥有某些资源的指定权限时可以使用此接口
  • ## 注意
  • - 该接口通过传递资源 code 定位对应的数据资源（如果是树类型，则需要传递节点的完整 code 路径）。
  • - 如果你在配置数据策略时配置了**环境属性**的条件判断，那么需要设置参数`judgeConditionEnabled`为`true`（默认为 false），并且通过参数`authEnvParams`传递请求时所处的环境信息（如 IP、设备类型、系统类型等），否则条件判断会不生效，导致数据策略不生效。 *
  • ## 场景举例
  • 用户在删除某条数据时，需要判断他是否拥有此资源的删除权限，则可以使用此接口。 *
  • ## 请求示例
  • ### 判断用户对字符串和数组资源权限示例（无条件判断） *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "action": "get",
  • "resources":["strResourceCode1", "arrayResourceCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data": {
  • "checkResultList": [
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resource": "strResourceCode1",
  • "action": "get",
  • "enabled": true
  • },
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resource": "arrayResourceCode1",
  • "action": "get",
  • "enabled": true
  • }
  • ]
  • }
  • }
  • ``` *
  • ### 判断用户对字符串和数组资源权限示例（开启条件判断） *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "action": "get",
  • "resources": ["strResourceCode1", "arrayResourceCode1"],
  • "judgeConditionEnabled": true,
  • "authEnvParams":{
  • "ip":"110.96.0.0",
  • "city":"北京",
  • "province":"北京",
  • "country":"中国",
  • "deviceType":"PC",
  • "systemType":"ios",
  • "browserType":"IE",
  • "requestDate":"2022-12-26 17:40:00"
  • }
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data": {
  • "checkResultList": [
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resource": "strResourceCode1",
  • "action": "get",
  • "enabled": false
  • },
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resource": "arrayResourceCode1",
  • "action": "get",
  • "enabled": false
  • }
  • ]
  • }
  • }
  • ``` *
  • ### 判断用户对树资源权限示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "action": "get",
  • "resources":["treeResourceCode1/StructCode1/resourceStructChildrenCode1", "treeResourceCode2/StructCode1/resourceStructChildrenCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "checkResultList": [{
  • "namespaceCode": "examplePermissionNamespace",
  • "action": "get",
  • "resource": "treeResourceCode1/StructCode1/resourceStructChildrenCode1",
  • "enabled": true
  • },{
  • "namespaceCode": "examplePermissionNamespace",
  • "action": "get",
  • "resource": "treeResourceCode2/StructCode1/resourceStructChildrenCode1",
  • "enabled": true
  • }]
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns CheckPermissionRespDto

func (*ManagementClient) CheckPermissionNamespaceExists added in v3.0.4 

func (client *ManagementClient) CheckPermissionNamespaceExists(reqDto *dto.CheckPermissionNamespaceExistsDto) *dto.PermissionNamespaceCheckExistsRespDto

* @summary 校验权限空间 Code 或者名称是否可用 * @description 通过用户池 ID 和权限空间 Code,或者用户池 ID 和权限空间名称查询是否可用。 * @param requestBody * @returns PermissionNamespaceCheckExistsRespDto

func (*ManagementClient) CheckSessionStatus 

func (client *ManagementClient) CheckSessionStatus(reqDto *dto.CheckSessionStatusDto) *dto.CheckSessionStatusRespDto

* @summary 检查某个用户在应用下是否具备 Session 登录态 * @description 检查某个用户在应用下是否具备 Session 登录态 * @param requestBody * @returns CheckSessionStatusRespDto

func (*ManagementClient) CheckUserSameLevelPermission added in v3.0.4 

func (client *ManagementClient) CheckUserSameLevelPermission(reqDto *dto.CheckUserSameLevelPermissionDto) *dto.CheckUserSameLevelPermissionResponseDto
  • @summary 判断用户在树资源同层级下的权限（推荐）
  • @description
  • ## 描述
  • 此接口用于判断用户是否拥有某一树资源的**同层级下**部分的节点的某种权限。由于树类型资源比较常用，所以我们基于“判断用户是否拥有资源权限”的业务场景，新增了针对判断树这种类型资源节点权限的接口。
  • ## 注意
  • 我们通过`resource`参数定位到树类型数据资源的某一层级（所以该参数是按照`资源 code/节点 code 路径`格式进行传递的），并通过`resourceNodeCodes`参数定位到是当前曾经的哪些节点。
  • ## 场景举例
  • 假如你的业务场景是：当在一个文件系统中，用户在删除某一文件夹下某些文件，需要判断他是否拥有这些文件的删除权限，则可以使用此接口。
  • ## 请求示例
  • ### 判断用户在树资源同层级权限示例（无条件判断） *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "action": "read",
  • "resource": "treeResourceCode/structCode",
  • "resourceNodeCodes": ["resourceStructChildrenCode1","resourceStructChildrenCode2","resourceStructChildrenCode3"]
  • }
  • ``` *
  • ### 判断用户在树资源同层级权限示例（开启条件判断） *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "action": "read",
  • "resource": "treeResourceCode/structCode",
  • "resourceNodeCodes": ["resourceStructChildrenCode1","resourceStructChildrenCode2","resourceStructChildrenCode3"],
  • "judgeConditionEnabled": true,
  • "authEnvParams":{
  • "ip":"110.96.0.0",
  • "city":"北京",
  • "province":"北京",
  • "country":"中国",
  • "deviceType":"PC",
  • "systemType":"ios",
  • "browserType":"IE",
  • "requestDate":"2022-12-26 17:40:00"
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns CheckUserSameLevelPermissionResponseDto

func (*ManagementClient) ConfigEmailProvider 

func (client *ManagementClient) ConfigEmailProvider(reqDto *dto.ConfigEmailProviderDto) *dto.EmailProviderRespDto

* @summary 配置第三方邮件服务 * @description 配置第三方邮件服务 * @param requestBody * @returns EmailProviderRespDto

func (*ManagementClient) CopyOperate added in v3.0.14 

func (client *ManagementClient) CopyOperate(reqDto *dto.FunctionModelOperateIdDto) *dto.CommonResponseDto

* @summary 复制自定义操作 * @description 复制自定义操作 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateAccessKey added in v3.0.4 

func (client *ManagementClient) CreateAccessKey(reqDto *dto.CreateAccessKeyDto) *dto.CreateAccessKeyResponseDto

* @summary 创建协作管理员的 AK/SK * @description 创建协作管理员的 AK/SK,根据协作管理员 ID 生成指定的 AK/SK。 * @param requestBody * @returns CreateAccessKeyResponseDto

func (*ManagementClient) CreateAdminRole added in v3.0.14 

func (client *ManagementClient) CreateAdminRole(reqDto *dto.CreateAdminRoleDto) *dto.RoleCheckParamsRespDto

* @summary 创建管理员角色 * @description 通过角色 code、角色名称进行创建管理员角色，可以选择角色描述 * @param requestBody * @returns RoleCheckParamsRespDto

func (*ManagementClient) CreateApplication 

func (client *ManagementClient) CreateApplication(reqDto *dto.CreateApplicationDto) *dto.CreateApplicationRespDto

* @summary 创建应用 * @description 创建应用 * @param requestBody * @returns CreateApplicationRespDto

func (*ManagementClient) CreateAsaAccount added in v3.0.4 

func (client *ManagementClient) CreateAsaAccount(reqDto *dto.CreateAsaAccountDto) *dto.AsaAccountSingleRespDto

* @summary 创建 ASA 账号 * @description 在某一应用下创建 ASA 账号 * @param requestBody * @returns AsaAccountSingleRespDto

func (*ManagementClient) CreateAsaAccountBatch added in v3.0.4 

func (client *ManagementClient) CreateAsaAccountBatch(reqDto *dto.CreateAsaAccountsBatchDto) *dto.IsSuccessRespDto

* @summary 批量创建 ASA 账号 * @description 在某一应用下批量创建 ASA 账号 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CreateDataPolicy added in v3.0.4 

func (client *ManagementClient) CreateDataPolicy(reqDto *dto.CreateDataPolicyDto) *dto.CreateDataPolicyResponseDto
  • @summary 创建数据策略（重点）
  • @description
  • ## 描述
  • 该接口用于创建数据策略，通过数据策略你可以将一组数据资源及其指定的操作进行绑定到一起，共同授权给主体。
  • ## 注意
  • 为了方便使用，`permissions` 字段我们基于路径的方式提供了快捷的写法，如：
  • - 数组、字符串资源：权限空间 code/数据资源 code/数据资源某一 action（如果表示所有操作，则使用`*`替代action）
  • - 树类型资源：权限空间 code/数据资源 code/node code 1/node code 1_1/.../数据资源某一 action *
  • ## 请求示例
  • 假设我们要对一名研发人员进行授权，首先创建 3 个数据资源如下：
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "服务器",
  • "resourceCode": "server_2023",
  • "type": "STRING",
  • "struct": "server_2023",
  • "actions": ["read", "write"]
  • }
  • ```
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "研发知识库",
  • "description": "",
  • "resourceCode": "rd_document",
  • "type": "STRING",
  • "struct": "https://www.authing.com/rd_document",
  • "actions": ["read", "write", "share"]
  • }
  • ```
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "研发内部平台菜单",
  • "description": "这是研发使用的内部平台菜单",
  • "resourceCode": "rd_internal_platform",
  • "type": "TREE",
  • "struct": [
  • {
  • "name": "部署",
  • "code": "deploy",
  • "children": [
  • {
  • "name": "生产环境",
  • "code": "prod"
  • },
  • {
  • "name": "测试环境",
  • "code": "test"
  • }
  • ]
  • },
  • {
  • "name": "数据库",
  • "code": "db"
  • "children": [
  • {
  • "name": "查询",
  • "code": "query"
  • },
  • {
  • "name": "导出",
  • "code": "export"
  • }
  • ]
  • }
  • ],
  • "actions": ["access", "execute"]
  • }
  • ```
  • 我们分配一台服务器：server_2023 给他使用，他可以在上面进行任意操作，同时他可以阅读、编辑研发知识库，最后他可以在研发内部平台中进行部署测试环境，但是不能够导出数据库数据。
  • ```json
  • {
  • "policyName": "研发人员策略",
  • "description": "这是一个示例数据策略",
  • "statementList": [
  • {
  • "effect": "ALLOW",
  • "permissions": [
  • "examplePermissionNamespaceCode/server_2023*",
  • "examplePermissionNamespaceCode/rd_document/read",
  • "examplePermissionNamespaceCode/rd_document/write",
  • "examplePermissionNamespaceCode/rd_internal_platform/deploy/test/execute"
  • ]
  • },
  • {
  • "effect": "DENY",
  • "permissions": [
  • "examplePermissionNamespaceCode/rd_internal_platform/db/export/execute"
  • ]
  • }
  • ]
  • }
  • ``` *
  • @param requestBody
  • @returns CreateDataPolicyResponseDto

func (*ManagementClient) CreateDataResource added in v3.0.4 

func (client *ManagementClient) CreateDataResource(reqDto *dto.CreateDataResourceDto) *dto.CreateDataResourceResponseDto
  • @summary 创建数据资源（推荐、重点）
  • @description
  • ## 描述
  • 该接口用于创建数据资源，当你存在需要被设置权限的数据，根据它们的数据类型，创建对应类型的数据资源，目前我们支持：字符串、数组、树三种类型。
  • ## 注意
  • 请求体中的 `struct` 字段需要根据不同的资源类型传入不同的数据结构，具体请参考下面的示例
  • ## 请求示例
  • ### 创建字符串类型数据资源示例
  • 当你的数据仅用一个字符串就可以表示时，可以使用此类型，例如：一个 API、一个用户 ID 等。
  • 以下是创建一个表示 '/resource/create' API 的数据资源示例：
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "createResource API",
  • "description": "这是 createResource API",
  • "resourceCode": "createResourceAPI",
  • "type": "STRING",
  • "struct": "/resource/create",
  • "actions": ["access"]
  • }
  • ``` *
  • ### 创建数组类型数据资源示例
  • 当你的数据是一组同类型的数据时，可以使用此类型，例如：一组文档链接、一组门禁卡号等。
  • 以下是创建一个表示一组门禁卡号的数据资源示例：
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "一组门禁卡号",
  • "description": "这是一组门禁卡号",
  • "resourceCode": "accessCardNumber",
  • "type": "ARRAY",
  • "struct": ["accessCardNumber1", "accessCardNumber2", "accessCardNumber3"],
  • "actions": ["get", "update"]
  • }
  • ``` *
  • ### 创建树类型数据资源示例
  • 当你的数据是具备层级关系时，可以使用此类型，例如：组织架构、文件夹结构等。
  • 以下是创建一个表示公司组织架构的数据资源示例：
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceName": "Authing",
  • "description": "这是 Authing 的组织架构",
  • "resourceCode": "authing",
  • "type": "TREE",
  • "struct": [
  • {
  • "name": "产品",
  • "code": "product",
  • "value": "product",
  • "children": [
  • {
  • "name": "产品经理",
  • "code": "productManager",
  • "value": "pm"
  • },
  • {
  • "name": "设计",
  • "code": "design",
  • "value": "ui"
  • }
  • ]
  • },
  • {
  • "name": "研发",
  • "code": "researchAndDevelopment",
  • "value": "rd"
  • }
  • ],
  • "actions": ["get", "update", "delete"]
  • }
  • ``` *
  • @param requestBody
  • @returns CreateDataResourceResponseDto

func (*ManagementClient) CreateDataResourceByArray added in v3.0.4 

func (client *ManagementClient) CreateDataResourceByArray(reqDto *dto.CreateArrayDataResourceDto) *dto.CreateArrayDataResourceResponseDto

* @summary 创建数组数据资源 * @description 当你仅需要创建数组类型数据资源时，可以使用此 API，我们固定了数据资源类型，你无需在传入 `type` 字符段，注意：`struct` 字段只能够传入数组类型数据。 * @param requestBody * @returns CreateArrayDataResourceResponseDto

func (*ManagementClient) CreateDataResourceByString added in v3.0.4 

func (client *ManagementClient) CreateDataResourceByString(reqDto *dto.CreateStringDataResourceDto) *dto.CreateStringDataResourceResponseDto

* @summary 创建字符串数据资源 * @description 当你仅需要创建字符串类型数据资源时，可以使用此 API，我们固定了数据资源类型，你无需在传入 `type` 字符段，注意：`struct` 字段只能够传入字符串类型数据。 * @param requestBody * @returns CreateStringDataResourceResponseDto

func (*ManagementClient) CreateDataResourceByTree added in v3.0.4 

func (client *ManagementClient) CreateDataResourceByTree(reqDto *dto.CreateTreeDataResourceDto) *dto.CreateTreeDataResourceResponseDto

* @summary 创建树数据资源 * @description 当你仅需要创建树类型数据资源时，可以使用此 API，我们固定了数据资源类型，你无需在传入 `type` 字符段，注意：`struct` 要按照树类型数据资源结构进行传入，请参考示例。 * @param requestBody * @returns CreateTreeDataResourceResponseDto

func (*ManagementClient) CreateDepartment 

func (client *ManagementClient) CreateDepartment(reqDto *dto.CreateDepartmentReqDto) *dto.DepartmentSingleRespDto

* @summary 创建部门 * @description 通过组织 code、部门名称、父部门 ID，创建部门，可以设置多种参数。 * @param requestBody * @returns DepartmentSingleRespDto

func (*ManagementClient) CreateDepartmentTree added in v3.0.4 

func (client *ManagementClient) CreateDepartmentTree(reqDto *dto.CreateDepartmentTreeReqDto) *dto.CreateDepartmentTreeRespDto

* @summary 根据组织树批量创建部门 * @description 根据组织树批量创建部门，部门名称不存在时会自动创建 * @param requestBody * @returns CreateDepartmentTreeRespDto

func (*ManagementClient) CreateDevice added in v3.0.14 

func (client *ManagementClient) CreateDevice(reqDto *dto.CreateTerminalDto) *dto.TerminalInfoRespDto

* @summary 删除风险策略 * @description 删除风险策略 * @param id * @returns CommonResponseDto

* @summary 新增设备 * @description 创建新设备。 * @param requestBody * @returns TerminalInfoRespDto

func (*ManagementClient) CreateEventApp added in v3.0.14 

func (client *ManagementClient) CreateEventApp(reqDto *dto.CreateEventAppDto) *dto.CommonResponseDto

* @summary 创建自定义事件应用 * @description 创建自定义事件应用 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateExtIdp 

func (client *ManagementClient) CreateExtIdp(reqDto *dto.CreateExtIdpDto) *dto.ExtIdpSingleRespDto

* @summary 创建身份源 * @description 创建身份源，可以设置身份源名称、连接类型、租户 ID 等。 * @param requestBody * @returns ExtIdpSingleRespDto

func (*ManagementClient) CreateExtIdpConn 

func (client *ManagementClient) CreateExtIdpConn(reqDto *dto.CreateExtIdpConnDto) *dto.ExtIdpConnDetailSingleRespDto

* @summary 在某个已有身份源下创建新连接 * @description 在某个已有身份源下创建新连接，可以设置身份源图标、是否只支持登录等。 * @param requestBody * @returns ExtIdpConnDetailSingleRespDto

func (*ManagementClient) CreateField added in v3.0.14 

func (client *ManagementClient) CreateField(reqDto *dto.CreateFunctionModelFieldDto) *dto.FunctionModelFieldResDto

* @summary 创建数据对象的字段 * @description 创建相关数据对象的字段，配置字段信息及基本校验规则 * @param requestBody * @returns FunctionModelFieldResDto

func (*ManagementClient) CreateGroup 

func (client *ManagementClient) CreateGroup(reqDto *dto.CreateGroupReqDto) *dto.GroupSingleRespDto

* @summary 创建分组 * @description 创建分组，一个分组必须包含分组名称与唯一标志符 code，且必须为一个合法的英文标志符，如 developers。 * @param requestBody * @returns GroupSingleRespDto

func (*ManagementClient) CreateGroupsBatch 

func (client *ManagementClient) CreateGroupsBatch(reqDto *dto.CreateGroupBatchReqDto) *dto.GroupListRespDto

* @summary 批量创建分组 * @description 批量创建分组，一个分组必须包含分组名称与唯一标志符 code，且必须为一个合法的英文标志符，如 developers。 * @param requestBody * @returns GroupListRespDto

func (*ManagementClient) CreateModel added in v3.0.14 

func (client *ManagementClient) CreateModel(reqDto *dto.CreateFunctionModelDto) *dto.FunctionModelResDto

* @summary 创建数据对象 * @description 利用此接口可以创建一个自定义的数据对象，定义数据对象的基本信息 * @param requestBody * @returns FunctionModelResDto

func (*ManagementClient) CreateMultipleTenantAdmin added in v3.0.14 

func (client *ManagementClient) CreateMultipleTenantAdmin(reqDto *dto.CreateMultipleTenantAdminDto) *dto.CommonResponseDto

* @summary 创建多租户管理员用户 * @description 根据用户 ID 创建一个用户池内拥有多租户管理权限的用户 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateNamespace 

func (client *ManagementClient) CreateNamespace(reqDto *dto.CreateNamespaceDto) *dto.NamespaceRespDto

* @summary 创建权限分组 * @description 创建权限分组，可以设置权限分组名称、Code 和描述信息。 * @param requestBody * @returns NamespaceRespDto

func (*ManagementClient) CreateNamespacesBatch 

func (client *ManagementClient) CreateNamespacesBatch(reqDto *dto.CreateNamespacesBatchDto) *dto.IsSuccessRespDto

* @summary 批量创建权限分组 * @description 批量创建权限分组，可以分别设置权限分组名称、Code 和描述信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CreateOperate added in v3.0.14 

func (client *ManagementClient) CreateOperate(reqDto *dto.CreateOperateModelDto) *dto.CommonResponseDto

* @summary 创建自定义操作 * @description 创建自定义操作 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateOrUpdateGroup added in v3.0.14 

func (client *ManagementClient) CreateOrUpdateGroup(reqDto *dto.CreateOrUpdateGroupReqDto) *dto.CreateOrUpdateGroupRespDto

* @summary 创建或修改分组 * @description 不存在时则创建，存在时则进行更新。 * @param requestBody * @returns CreateOrUpdateGroupRespDto

func (*ManagementClient) CreateOrganization 

func (client *ManagementClient) CreateOrganization(reqDto *dto.CreateOrganizationReqDto) *dto.OrganizationSingleRespDto

* @summary 创建组织机构 * @description 创建组织机构，会创建一个只有一个节点的组织机构，可以选择组织描述信息、根节点自定义 ID、多语言等。 * @param requestBody * @returns OrganizationSingleRespDto

func (*ManagementClient) CreatePermissionNamespace added in v3.0.4 

func (client *ManagementClient) CreatePermissionNamespace(reqDto *dto.CreatePermissionNamespaceDto) *dto.CreatePermissionNamespaceResponseDto

* @summary 创建权限空间 * @description 创建权限空间,可以设置权限空间名称、Code 和描述信息。 * @param requestBody * @returns CreatePermissionNamespaceResponseDto

func (*ManagementClient) CreatePermissionNamespacesBatch added in v3.0.4 

func (client *ManagementClient) CreatePermissionNamespacesBatch(reqDto *dto.CreatePermissionNamespacesBatchDto) *dto.IsSuccessRespDto

* @summary 批量创建权限空间 * @description 批量创建权限空间，可以分别设置权限空间名称、Code 和描述信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CreatePipelineFunction 

func (client *ManagementClient) CreatePipelineFunction(reqDto *dto.CreatePipelineFunctionDto) *dto.PipelineFunctionSingleRespDto

* @summary 创建 Pipeline 函数 * @description 创建 Pipeline 函数 * @param requestBody * @returns PipelineFunctionSingleRespDto

func (*ManagementClient) CreatePost added in v3.0.14 

func (client *ManagementClient) CreatePost(reqDto *dto.CreatePostDto) *dto.CreatePostRespDto

* @summary 创建岗位 * @description 创建岗位 * @param requestBody * @returns CreatePostRespDto

func (*ManagementClient) CreatePublicAccount added in v3.0.14 

func (client *ManagementClient) CreatePublicAccount(reqDto *dto.CreatePublicAccountReqDto) *dto.PublicAccountSingleRespDto

* @summary 创建公共账号 * @description 创建公共账号，邮箱、手机号、用户名必须包含其中一个，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份创建公共账号用户因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns PublicAccountSingleRespDto

func (*ManagementClient) CreatePublicAccountsBatch added in v3.0.14 

func (client *ManagementClient) CreatePublicAccountsBatch(reqDto *dto.CreatePublicAccountBatchReqDto) *dto.PublicAccountListRespDto

* @summary 批量创建公共账号 * @description 批量创建公共账号，邮箱、手机号、用户名必须包含其中一个，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份创建公共账号用户因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns PublicAccountListRespDto

func (*ManagementClient) CreateResource 

func (client *ManagementClient) CreateResource(reqDto *dto.CreateResourceDto) *dto.ResourceRespDto

* @summary 创建资源 * @description 创建资源，可以设置资源的描述、定义的操作类型、URL 标识等。 * @param requestBody * @returns ResourceRespDto

func (*ManagementClient) CreateResourcesBatch 

func (client *ManagementClient) CreateResourcesBatch(reqDto *dto.CreateResourcesBatchDto) *dto.IsSuccessRespDto

* @summary 批量创建资源 * @description 批量创建资源，可以设置资源的描述、定义的操作类型、URL 标识等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CreateRole 

func (client *ManagementClient) CreateRole(reqDto *dto.CreateRoleDto) *dto.RoleSingleRespDto

* @summary 创建角色 * @description 通过权限分组（权限空间）内角色 code，创建角色，可以选择权限分组、角色描述、角色名称等。 * @param requestBody * @returns RoleSingleRespDto

func (*ManagementClient) CreateRolesBatch 

func (client *ManagementClient) CreateRolesBatch(reqDto *dto.CreateRolesBatch) *dto.IsSuccessRespDto

* @summary 批量创建角色 * @description 批量创建角色，可以选择权限分组、角色描述等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) CreateRow added in v3.0.14 

func (client *ManagementClient) CreateRow(reqDto *dto.CreateRowDto) *dto.FunctionModelValueResDto

* @summary 添加行 * @description 添加行 * @param requestBody * @returns FunctionModelValueResDto

func (*ManagementClient) CreateRowRelation added in v3.0.14 

func (client *ManagementClient) CreateRowRelation(reqDto *dto.CreateRelationValueDto) *dto.CommonResponseDto

* @summary 创建行关联数据 * @description 创建行关联数据 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateSyncTask 

func (client *ManagementClient) CreateSyncTask(reqDto *dto.CreateSyncTaskDto) *dto.SyncTaskPaginatedRespDto

* @summary 创建同步任务 * @description 创建同步任务 * @param requestBody * @returns SyncTaskPaginatedRespDto

func (*ManagementClient) CreateTenant added in v3.0.14 

func (client *ManagementClient) CreateTenant(reqDto *dto.CreateTenantDto) *dto.CreateTenantRespDto

* @summary 创建租户 * @param requestBody * @returns CreateTenantRespDto

func (*ManagementClient) CreateTenantCooperator added in v3.0.14 

func (client *ManagementClient) CreateTenantCooperator(reqDto *dto.CreateTenantCooperatorDto) *dto.CommonResponseDto

* @summary 创建协调管理员 * @description 创建一个协调管理员 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) CreateTenantUser added in v3.0.14 

func (client *ManagementClient) CreateTenantUser(reqDto *dto.CreateTenantUserReqDto) *dto.TenantUserDto

* @summary 创建租户成员 * @description 创建租户成员，邮箱、手机号、用户名必须包含其中一个，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份创建用户因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns TenantUserDto

func (*ManagementClient) CreateUser 

func (client *ManagementClient) CreateUser(reqDto *dto.CreateUserReqDto) *dto.UserSingleRespDto

* @summary 创建用户 * @description 创建用户，邮箱、手机号、用户名必须包含其中一个，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份创建用户因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns UserSingleRespDto

func (*ManagementClient) CreateUsersBatch 

func (client *ManagementClient) CreateUsersBatch(reqDto *dto.CreateUserBatchReqDto) *dto.UserListRespDto

* @summary 批量创建用户 * @description 批量创建用户，邮箱、手机号、用户名必须包含其中一个，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份创建用户因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns UserListRespDto

func (*ManagementClient) CreateVerifyDevice added in v3.0.14 

func (client *ManagementClient) CreateVerifyDevice(reqDto *dto.CreateTerminalDto) *dto.TerminalInfoRespDto

* @summary 新增 verify 设备 * @description 创建 verify 新设备。 * @param requestBody * @returns TerminalInfoRespDto

func (*ManagementClient) CreateWebhook 

func (client *ManagementClient) CreateWebhook(reqDto *dto.CreateWebhookDto) *dto.CreateWebhookRespDto

* @summary 创建 Webhook * @description 你需要指定 Webhook 名称、Webhook 回调地址、请求数据格式、用户真实名称来创建 Webhook。还可选是否启用、请求密钥进行创建 * @param requestBody * @returns CreateWebhookRespDto

func (*ManagementClient) DefineEvent added in v3.0.14 

func (client *ManagementClient) DefineEvent(reqDto *dto.DefineEventDto) *dto.CommonResponseDto

* @summary 定义自定义事件 * @description 在 Authing 事件中心定义自定义事件 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteAccessKey added in v3.0.4 

func (client *ManagementClient) DeleteAccessKey(reqDto *dto.DeleteAccessKeyDto) *dto.CommonResponseDto

* @summary 删除协作管理员的 AK/SK * @description 删除协作管理员的 AK/SK,根据所选择的 AK/SK 的 accessKeyId 进行指定删除。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteAdminRolesBatch added in v3.0.14 

func (client *ManagementClient) DeleteAdminRolesBatch(reqDto *dto.DeleteAdminRoleDto) *dto.IsSuccessRespDto

* @summary 删除管理员自定义角色 * @description 删除管理员自定义角色，支持批量删除。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteApplication 

func (client *ManagementClient) DeleteApplication(reqDto *dto.DeleteApplicationDto) *dto.IsSuccessRespDto

* @summary 删除应用 * @description 通过应用 ID，删除应用。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteAsaAccount added in v3.0.4 

func (client *ManagementClient) DeleteAsaAccount(reqDto *dto.DeleteAsaAccountDto) *dto.IsSuccessRespDto

* @summary 删除 ASA 账号 * @description 通过 ASA 账号 ID 删除 ASA 账号 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteAsaAccountBatch added in v3.0.4 

func (client *ManagementClient) DeleteAsaAccountBatch(reqDto *dto.DeleteAsaAccountBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除 ASA 账号 * @description 通过 ASA 账号 ID 批量删除 ASA 账号 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteCustomFields added in v3.0.14 

func (client *ManagementClient) DeleteCustomFields(reqDto *dto.DeleteCustomFieldsReqDto) *dto.IsSuccessRespDto

* @summary 删除自定义字段定义 * @description 删除用户、部门或角色自定义字段定义。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteDataPolicy added in v3.0.4 

func (client *ManagementClient) DeleteDataPolicy(reqDto *dto.DeleteDataPolicyDto) *dto.CommonResponseDto

* @summary 删除数据策略 * @description 删除数据策略，通过数据策略 ID 删除对应的策略,同时也删除数据策略和对应的数据资源等关系数据。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteDataResource added in v3.0.4 

func (client *ManagementClient) DeleteDataResource(reqDto *dto.DeleteDataResourceDto) *dto.CommonResponseDto

* @summary 删除数据资源 * @description 删除数据资源,根据数据资源 ID 删除对应的数据资源信息。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteDepartment 

func (client *ManagementClient) DeleteDepartment(reqDto *dto.DeleteDepartmentReqDto) *dto.IsSuccessRespDto

* @summary 删除部门 * @description 通过组织 code、部门 ID，删除部门。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteDepartmentSyncRelations added in v3.0.14 

func (client *ManagementClient) DeleteDepartmentSyncRelations(reqDto *dto.DeleteDepartmentSyncRelationReqDto) *dto.IsSuccessRespDto

* @summary 删除部门同步关联关系 * @description 如果在 Authing 中的部门进行了上下游同步，此接口可以用于删除某个部门在指定身份源下的关联关系。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteDevice added in v3.0.14 

func (client *ManagementClient) DeleteDevice(reqDto *dto.DeleteTerminalUserDto) *dto.CommonResponseDto

* @summary 移除绑定(用户详情页) * @description 移除绑定(用户详情页)。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteExtIdp 

func (client *ManagementClient) DeleteExtIdp(reqDto *dto.DeleteExtIdpDto) *dto.IsSuccessRespDto

* @summary 删除身份源 * @description 通过身份源 ID，删除身份源。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteExtIdpConn 

func (client *ManagementClient) DeleteExtIdpConn(reqDto *dto.DeleteExtIdpConnDto) *dto.IsSuccessRespDto

* @summary 删除身份源连接 * @description 通过身份源连接 ID，删除身份源连接。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteGroupsBatch 

func (client *ManagementClient) DeleteGroupsBatch(reqDto *dto.DeleteGroupsReqDto) *dto.IsSuccessRespDto

* @summary 批量删除分组 * @description 通过分组 code，批量删除分组。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteMultipleTenantAdmin added in v3.0.14 

func (client *ManagementClient) DeleteMultipleTenantAdmin(reqDto *dto.DeleteMultipleTenantAdminBodyDto) *dto.CommonResponseDto

* @summary 删除多租户管理员用户 * @description 根据用户 ID 删除一个用户池内拥有多租户管理权限的用户 * @param requestBody * @param userId 用户 ID（请使用 body 中的 userId） * @returns CommonResponseDto

func (*ManagementClient) DeleteNamespace 

func (client *ManagementClient) DeleteNamespace(reqDto *dto.DeleteNamespaceDto) *dto.IsSuccessRespDto

* @summary 删除权限分组信息 * @description 通过权限分组唯一标志符(Code)，删除权限分组信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteNamespacesBatch 

func (client *ManagementClient) DeleteNamespacesBatch(reqDto *dto.DeleteNamespacesBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除权限分组 * @description 分别通过权限分组唯一标志符(Code)，批量删除权限分组。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteOrganization 

func (client *ManagementClient) DeleteOrganization(reqDto *dto.DeleteOrganizationReqDto) *dto.IsSuccessRespDto

* @summary 删除组织机构 * @description 通过组织 code，删除组织机构树。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeletePermissionNamespace added in v3.0.4 

func (client *ManagementClient) DeletePermissionNamespace(reqDto *dto.DeletePermissionNamespaceDto) *dto.IsSuccessRespDto

* @summary 删除权限空间 * @description 通过权限空间唯一标志符(Code)，删除权限空间信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeletePermissionNamespacesBatch added in v3.0.4 

func (client *ManagementClient) DeletePermissionNamespacesBatch(reqDto *dto.DeletePermissionNamespacesBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除权限空间 * @description 分别通过权限空间唯一标志符(Code)，批量删除权限空间信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeletePipelineFunction 

func (client *ManagementClient) DeletePipelineFunction(reqDto *dto.DeletePipelineFunctionDto) *dto.CommonResponseDto

* @summary 删除 Pipeline 函数 * @description 删除 Pipeline 函数 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeletePublicAccountsBatch added in v3.0.14 

func (client *ManagementClient) DeletePublicAccountsBatch(reqDto *dto.DeletePublicAccountsBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除公共账号 * @description 通过公共账号 ID 列表，删除公共账号，支持批量删除，可以选择指定用户 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteResource 

func (client *ManagementClient) DeleteResource(reqDto *dto.DeleteResourceDto) *dto.IsSuccessRespDto

* @summary 删除资源 * @description 通过资源唯一标志符以及所属权限分组，删除资源。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteResourcesBatch 

func (client *ManagementClient) DeleteResourcesBatch(reqDto *dto.DeleteResourcesBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除资源 * @description 通过资源唯一标志符以及所属权限分组，批量删除资源 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteRoles added in v3.0.4 

func (client *ManagementClient) DeleteRoles(reqDto *dto.DeleteRoleBatchDto) *dto.IsSuccessRespDto

* @summary 跨权限分组（空间）删除角色 * @description 跨权限分组（空间）删除角色，可以批量删除。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteRolesBatch 

func (client *ManagementClient) DeleteRolesBatch(reqDto *dto.DeleteRoleDto) *dto.IsSuccessRespDto

* @summary 单个权限分组（权限空间）内删除角色 * @description 单个权限分组（权限空间）内删除角色，可以批量删除。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteTenant added in v3.0.14 

func (client *ManagementClient) DeleteTenant(reqDto *dto.DeleteTenantDto) *dto.IsSuccessRespDto

* @summary 删除租户 * @description 此接口用于删除租户。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteTenantAdmin added in v3.0.14 

func (client *ManagementClient) DeleteTenantAdmin(reqDto *dto.GetTenantUserDto) *dto.CommonResponseDto

* @summary 取消设置租户管理员 * @description 此接口用于根据用户 ID 或租户成员 ID 取消设置租户管理员。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteTenantCooperator added in v3.0.14 

func (client *ManagementClient) DeleteTenantCooperator(reqDto *dto.DeleteTenantCooperatorBodyDto) *dto.CommonResponseDto

* @summary 删除协调管理员 * @description 使用用户 ID 删除一个协调管理员 * @param requestBody * @param userId 用户 ID（请使用 body 中的 userId） * @returns CommonResponseDto

func (*ManagementClient) DeleteTenantUser added in v3.0.14 

func (client *ManagementClient) DeleteTenantUser(reqDto *dto.RemoveTenantUsersDto) *dto.CommonResponseDto

* @summary 批量移除租户成员 * @description 此接口用于根据用户 ID 或租户成员 ID 批量移除租户成员。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DeleteUserSyncRelations added in v3.0.14 

func (client *ManagementClient) DeleteUserSyncRelations(reqDto *dto.DeleteUserSyncRelationReqDto) *dto.IsSuccessRespDto

* @summary 删除用户同步关联关系 * @description 如果在 Authing 中的用户进行了上下游同步，此接口可以用于删除某个用户在指定身份源下的关联关系。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteUsersBatch 

func (client *ManagementClient) DeleteUsersBatch(reqDto *dto.DeleteUsersBatchDto) *dto.IsSuccessRespDto

* @summary 批量删除用户 * @description 通过用户 ID 列表，删除用户，支持批量删除，可以选择指定用户 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) DeleteWebhook 

func (client *ManagementClient) DeleteWebhook(reqDto *dto.DeleteWebhookDto) *dto.DeleteWebhookRespDto

* @summary 删除 Webhook * @description 通过指定多个 webhookId,以数组的形式进行 webhook 的删除,如果 webhookId 不存在,不提示报错 * @param requestBody * @returns DeleteWebhookRespDto

func (*ManagementClient) DeleteWhitelist added in v3.0.14 

func (client *ManagementClient) DeleteWhitelist(reqDto *dto.DeleteWhitelistDto) *dto.IsSuccessDto

* @summary 删除注册白名单 * @description 通过指定多个注册白名单数据,以数组的形式进行注册白名单的删除 * @param requestBody * @returns IsSuccessDto

func (*ManagementClient) DetailAuthSubject added in v3.0.14 

func (client *ManagementClient) DetailAuthSubject(reqDto *dto.GetSubjectAuthDetailDto) *dto.GetSubjectAuthRespDto

* @summary 主体授权详情 * @description 主体授权详情 * @param targetId 主体 id * @param targetType 主体类型 * @param appId 应用 ID * @returns GetSubjectAuthRespDto

func (*ManagementClient) DisableDevice added in v3.0.14 

func (client *ManagementClient) DisableDevice(reqDto *dto.UpdateTerminalUserDto) *dto.CommonResponseDto

* @summary 停用设备(用户详情页) * @description 停用设备(用户详情页)。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) DisableLdapServer added in v3.0.14 

func (client *ManagementClient) DisableLdapServer(reqDto *dto.LdapSetEnabledFlagDto) *dto.LdapOperateRespDto

* @summary 关闭 LDAP server 服务，关闭前必须先初始化 * @description 关闭 LDAP server 服务，关闭前必须先初始化 * @param requestBody * @returns LdapOperateRespDto

func (*ManagementClient) EnableDevice added in v3.0.14 

func (client *ManagementClient) EnableDevice(reqDto *dto.UpdateTerminalUserDto) *dto.CommonResponseDto

* @summary 启用设备(用户详情页) * @description 启用设备(用户详情页)。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) EnabledAuth added in v3.0.14 

func (client *ManagementClient) EnabledAuth(reqDto *dto.UpdateAuthEnabledDto) *dto.IsSuccessRespDto

* @summary 更新授权开关 * @description 更新授权开关 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) ExecuteOperate added in v3.0.14 

func (client *ManagementClient) ExecuteOperate(reqDto *dto.FunctionModelOperateIdDto) *dto.CommonResponseDto

* @summary 执行自定义操作 * @description 执行自定义操作 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) Export added in v3.0.14 

func (client *ManagementClient) Export(reqDto *dto.ExportModelDto) *dto.CommonResponseDto

* @summary 导出全部数据 * @description 导出全部数据 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ExportModel added in v3.0.14 

func (client *ManagementClient) ExportModel(reqDto *dto.ExportMetadataDto) *dto.CommonResponseDto

* @summary 导出数据对象 * @description 导出数据对象 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ExtIdpConnStateByApps 

func (client *ManagementClient) ExtIdpConnStateByApps(reqDto *dto.ExtIdpConnAppsDto) *dto.ExtIdpListPaginatedRespDto

* @summary 身份源下应用的连接详情 * @description 在身份源详情页获取应用的连接情况 * @param id 身份源 ID * @param tenantId 租户 ID * @param appId 应用 ID * @param type 身份源类型 * @returns ExtIdpListPaginatedRespDto

func (*ManagementClient) FindIpList added in v3.0.14 

func (client *ManagementClient) FindIpList(reqDto *dto.IpListDto) *dto.IpListPaginatedRespDto

* @summary 获取 ip 列表 * @description 分页获取 ip 列表 * @param ipType IP 类型 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns IpListPaginatedRespDto

func (*ManagementClient) FindLastLoginAppsByDeviceIds added in v3.0.14 

func (client *ManagementClient) FindLastLoginAppsByDeviceIds(reqDto *dto.QueryTerminalAppsDto) *dto.CommonResponseDto

* @summary 最近登录应用 * @description 根据设备唯一标识获取最近登录的应用列表。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) FindRiskListPolicy added in v3.0.14 

func (client *ManagementClient) FindRiskListPolicy(reqDto *dto.RiskListPolicyDto) *dto.UserListPolicyPaginatedRespDto

* @summary 删除用户名单 * @description 删除用户 名单 * @param id * @returns CommonResponseDto

* @summary 获取风险策略列表 * @description 分页获取风险策略列表 * @param optObject 策略操作对象，目前只有 ip * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns UserListPolicyPaginatedRespDto

func (*ManagementClient) FindUserList added in v3.0.14 

func (client *ManagementClient) FindUserList(reqDto *dto.UserListDto) *dto.UserListPaginatedRespDto

* @summary 删除 ip 名单 * @description 删除 ip 名单 * @param id * @returns CommonResponseDto

* @summary 获取用户列表 * @description 分页获取用户列表 * @param userListType IP 类型 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns UserListPaginatedRespDto 

func (client *ManagementClient) GenerateInviteTenantUserLink(reqDto *dto.GenerateInviteTenantUserLink) *dto.InviteTenantUsersRespDto

* @summary 生成一个邀请租户成员的链接 * @description 此接口用于生成一个邀请租户成员的链接。appId 为用户注册成功后要访问的应用 ID * @param requestBody * @returns InviteTenantUsersRespDto

func (*ManagementClient) GetAccessKey added in v3.0.4 

func (client *ManagementClient) GetAccessKey(reqDto *dto.GetAccessKeyDto) *dto.GetAccessKeyResponseDto

* @summary 获取协作管理员 AK/SK 详细信息 * @description 获取协作管理员 AK/SK 详细信息,根据协作管理员 ID 和 accessKeyId 获取对应 AK/SK 的详细信息。 * @param userId 用户 ID * @param accessKeyId accessKeyId * @returns GetAccessKeyResponseDto

func (*ManagementClient) GetAccessKeyList added in v3.0.4 

func (client *ManagementClient) GetAccessKeyList(reqDto *dto.ListAccessKeyDto) *dto.ListAccessKeyResponseDto

* @summary 获取协作管理员 AK/SK 列表 * @description 根据协作管理员 Id 获取协作管理员下所有的 AK/SK 列表 * @param userId 密钥所属用户 ID * @param tenantId 密钥所属租户 ID * @param type 密钥类型 * @param status AccessKey 状态，activated：已激活，staging：分级（可轮换），revoked：已撤销 * @returns ListAccessKeyResponseDto

func (*ManagementClient) GetAdminAuditLogs 

func (client *ManagementClient) GetAdminAuditLogs(reqDto *dto.GetAdminAuditLogsDto) *dto.AdminAuditLogRespDto

* @summary 获取管理员操作日志 * @description 可以选择请求 ID、客户端 IP、操作类型、资源类型、管理员用户 ID、请求是否成功、开始时间戳、结束时间戳、分页来获取管理员操作日志接口 * @param requestBody * @returns AdminAuditLogRespDto

func (*ManagementClient) GetAllDepartments added in v3.0.14 

func (client *ManagementClient) GetAllDepartments(reqDto *dto.GetAllDepartmentsDto) *dto.DepartmentPaginatedRespDto

* @summary 获取所有部门列表 * @description 获取所有部门列表，可以用于获取某个组织下的所有部门列表。 * @param organizationCode 组织 code * @param departmentId 部门 ID，不填写默认为 `root` 根部门 ID * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param withCustomData 是否获取自定义数据 * @returns DepartmentPaginatedRespDto

func (*ManagementClient) GetAllGroups added in v3.0.14 

func (client *ManagementClient) GetAllGroups(reqDto *dto.GetAllGroupsDto) *dto.GroupListRespDto

* @summary 获取所有分组 * @description 获取所有分组 * @param fetchMembers 是否获取成员列表 * @param withCustomData 是否获取自定义数据 * @returns GroupListRespDto

func (*ManagementClient) GetAllRightsItem 

func (client *ManagementClient) GetAllRightsItem() *dto.CostGetAllRightItemRespDto

* @summary 获取所有权益 * @description 获取当前用户池所有权益 * @returns CostGetAllRightItemRespDto

func (*ManagementClient) GetApplication 

func (client *ManagementClient) GetApplication(reqDto *dto.GetApplicationDto) *dto.ApplicationSingleRespDto

* @summary 获取应用详情 * @description 通过应用 ID，获取应用详情。 * @param appId 应用 ID * @returns ApplicationSingleRespDto

func (*ManagementClient) GetApplicationPermissionStrategy 

func (client *ManagementClient) GetApplicationPermissionStrategy(reqDto *dto.GetApplicationPermissionStrategyDto) *dto.GetApplicationPermissionStrategyRespDto

* @summary 获取应用默认访问授权策略 * @description 获取应用默认访问授权策略 * @param appId 应用 ID * @returns GetApplicationPermissionStrategyRespDto

func (*ManagementClient) GetApplicationSecret 

func (client *ManagementClient) GetApplicationSecret(reqDto *dto.GetApplicationSecretDto) *dto.GetApplicationSecretRespDto

* @summary 获取应用密钥 * @description 获取应用密钥 * @param appId 应用 ID * @returns GetApplicationSecretRespDto

func (*ManagementClient) GetApplicationSimpleInfo 

func (client *ManagementClient) GetApplicationSimpleInfo(reqDto *dto.GetApplicationSimpleInfoDto) *dto.ApplicationSimpleInfoSingleRespDto

* @summary 获取应用简单信息 * @description 通过应用 ID，获取应用简单信息。 * @param appId 应用 ID * @returns ApplicationSimpleInfoSingleRespDto

func (*ManagementClient) GetAsaAccount added in v3.0.4 

func (client *ManagementClient) GetAsaAccount(reqDto *dto.GetAsaAccountDto) *dto.AsaAccountSingleRespDto

* @summary 获取 ASA 账号 * @description 根据 ASA 账号 ID 获取账号详细信息 * @param appId 所属应用 ID * @param accountId ASA 账号 ID * @returns AsaAccountSingleRespDto

func (*ManagementClient) GetAsaAccountAssignedTargets added in v3.0.4 

func (client *ManagementClient) GetAsaAccountAssignedTargets(reqDto *dto.GetAsaAccountAssignedTargetsDto) *dto.GetAsaAccountAssignedTargetRespDto

* @summary 获取 ASA 账号分配的主体列表 * @description 根据 ASA 账号 ID 分页获取账号被分配的主体列表 * @param appId 所属应用 ID * @param accountId ASA 账号 ID * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns GetAsaAccountAssignedTargetRespDto

func (*ManagementClient) GetAsaAccountBatch added in v3.0.4 

func (client *ManagementClient) GetAsaAccountBatch(reqDto *dto.GetAsaAccountBatchDto) *dto.AsaAccountListRespDto

* @summary 批量获取 ASA 账号 * @description 根据 ASA 账号 ID 列表批量获取账号详细信息 * @param requestBody * @returns AsaAccountListRespDto

func (*ManagementClient) GetAssignedAccount added in v3.0.4 

func (client *ManagementClient) GetAssignedAccount(reqDto *dto.GetAssignedAccountDto) *dto.AsaAccountSingleNullableRespDto
  • @summary 获取主体被分配的 ASA 账号
  • @description 根据主体类型和标识获取直接分配给主体的 ASA 账号
  • @param appId 所属应用 ID
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门 *
  • @param targetIdentifier 目标对象的唯一标志符：
  • - 如果是用户，为用户的 ID，如 `6343b98b7cfxxx9366e9b7c`
  • - 如果是角色，为角色的 code，如 `admin`
  • - 如果是分组，为分组的 code，如 `developer`
  • - 如果是部门，为部门的 ID，如 `6343bafc019xxxx889206c4c` *
  • @returns AsaAccountSingleNullableRespDto

func (*ManagementClient) GetAuthorizedResources 

func (client *ManagementClient) GetAuthorizedResources(reqDto *dto.GetAuthorizedResourcesDto) *dto.AuthorizedResourcePaginatedRespDto
  • @summary 获取某个主体被授权的资源列表
  • @description 根据筛选条件，获取某个主体被授权的资源列表。
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门 *
  • @param targetIdentifier 目标对象的唯一标志符：
  • - 如果是用户，为用户的 ID，如 `6343b98b7cfxxx9366e9b7c`
  • - 如果是角色，为角色的 code，如 `admin`
  • - 如果是分组，为分组的 code，如 `developer`
  • - 如果是部门，为部门的 ID，如 `6343bafc019xxxx889206c4c` *
  • @param namespace 所属权限分组(权限空间)的 Code
  • @param resourceType 限定资源类型，如数据、API、按钮、菜单
  • @param resourceList 限定查询的资源列表，如果指定，只会返回所指定的资源列表。
  • @param withDenied 是否获取被拒绝的资源
  • @returns AuthorizedResourcePaginatedRespDto

func (*ManagementClient) GetBindPwd added in v3.0.14 

func (client *ManagementClient) GetBindPwd() *dto.LdapGetBindPwdRespDto

* @summary 生成 LDAP Server 管理员密码 * @description 生成 LDAP Server 管理员密码 * @returns LdapGetBindPwdRespDto

func (*ManagementClient) GetCurrentPackageInfo 

func (client *ManagementClient) GetCurrentPackageInfo() *dto.CostGetCurrentPackageRespDto

* @summary 获取套餐详情 * @description 获取当前用户池套餐详情。 * @returns CostGetCurrentPackageRespDto

func (*ManagementClient) GetCustomData 

func (client *ManagementClient) GetCustomData(reqDto *dto.GetCustomDataDto) *dto.GetCustomDataRespDto
  • @summary 获取用户、分组、角色、组织机构的自定义字段值
  • @description 通过筛选条件，获取用户、分组、角色、组织机构的自定义字段值。
  • @param tenantId 租户 ID
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门 *
  • @param targetIdentifier 目标对象的唯一标志符：
  • - 如果是用户，为用户的 ID，如 `6343b98b7cfxxx9366e9b7c`
  • - 如果是角色，为角色的 code，如 `admin`
  • - 如果是分组，为分组的 code，如 `developer`
  • - 如果是部门，为部门的 ID，如 `6343bafc019xxxx889206c4c` *
  • @param namespace 所属权限分组的 code，当 targetType 为角色的时候需要填写，否则可以忽略
  • @returns GetCustomDataRespDto

func (*ManagementClient) GetCustomFields 

func (client *ManagementClient) GetCustomFields(reqDto *dto.GetCustomFieldsDto) *dto.CustomFieldListRespDto
  • @summary 获取自定义字段列表
  • @description 通过主体类型，获取用户、部门或角色的自定义字段列表。
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门
  • ;该接口暂不支持分组(GROUP)
  • @param tenantId 租户 ID
  • @returns CustomFieldListRespDto

func (*ManagementClient) GetDataPolicy added in v3.0.4 

func (client *ManagementClient) GetDataPolicy(reqDto *dto.GetDataPolicyDto) *dto.GetDataPolicyResponseDto

* @summary 获取数据策略信息 * @description 获取数据策略信息，通过数据策略 ID 获取对应数据策略信息,包含数据策略 ID、数据策略名称、数据策略描述、数据策略下所有的数据权限列表等信息。 * @param policyId 数据策略 ID * @returns GetDataPolicyResponseDto

func (*ManagementClient) GetDataResource added in v3.0.4 

func (client *ManagementClient) GetDataResource(reqDto *dto.GetDataResourceDto) *dto.GetDataResourceResponseDto

* @summary 获取数据资源信息 * @description 获取数据资源,通过数据资源 ID 查询对应的数据资源信息,包含数据资源名称、数据资源 Code、数据资源类型（TREE、STRING、ARRAY）、数据资源所属权限空间 ID、数据资源所属权限空间 Code 以及数据资源操作列表等基本信息。 * @param namespaceCode 数据资源所属的权限空间 Code * @param resourceCode 数据资源 Code, 权限空间内唯一 * @returns GetDataResourceResponseDto

func (*ManagementClient) GetDepartment 

func (client *ManagementClient) GetDepartment(reqDto *dto.GetDepartmentDto) *dto.DepartmentSingleRespDto

* @summary 获取部门信息 * @description 通过组织 code 以及 部门 ID 或 部门 code，获取部门信息，可以获取自定义数据。 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root`。departmentId 和 departmentCode 必传其一。 * @param departmentCode 部门 code。departmentId 和 departmentCode 必传其一。 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param withCustomData 是否获取自定义数据 * @param flatCustomData 是否拍平扩展字段 * @param tenantId 租户 ID * @returns DepartmentSingleRespDto

func (*ManagementClient) GetDepartmentById added in v3.0.4 

func (client *ManagementClient) GetDepartmentById(reqDto *dto.GetDepartmentByIdDto) *dto.DepartmentSingleRespDto

* @summary 根据部门id查询部门 * @description 根据部门id查询部门 * @param departmentId 部门 ID * @param tenantId 租户 ID * @param withCustomData 是否获取自定义数据 * @returns DepartmentSingleRespDto

func (*ManagementClient) GetDepartmentSyncRelations added in v3.0.14 

func (client *ManagementClient) GetDepartmentSyncRelations(reqDto *dto.GetDepartmentSyncRelationsDto) *dto.SyncRelationListRespDto

* @summary 获取部门绑定的第三方同步关系 * @description 如果在 Authing 中的部门进行了上下游同步，此接口可以用于查询出在第三方的关联用户信息 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root`。departmentId 和 departmentCode 必传其一。 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param withCustomData 是否获取自定义数据 * @param tenantId 租户 ID * @returns SyncRelationListRespDto

func (*ManagementClient) GetDeviceStatus added in v3.0.14 

func (client *ManagementClient) GetDeviceStatus(reqDto *dto.TerminalBaseDto) *dto.DeviceStatusRespDto

* @summary 获取设备状态 * @description 获取设备状态。 * @param requestBody * @returns DeviceStatusRespDto

func (*ManagementClient) GetEmailProvider 

func (client *ManagementClient) GetEmailProvider() *dto.EmailProviderRespDto

* @summary 获取第三方邮件服务配置 * @description 获取第三方邮件服务配置 * @returns EmailProviderRespDto

func (*ManagementClient) GetEmailTemplates 

func (client *ManagementClient) GetEmailTemplates() *dto.GetEmailTemplatesRespDto

* @summary 获取邮件模版列表 * @description 获取邮件模版列表 * @returns GetEmailTemplatesRespDto

func (*ManagementClient) GetExtIdp 

func (client *ManagementClient) GetExtIdp(reqDto *dto.GetExtIdpDto) *dto.ExtIdpDetailSingleRespDto

* @summary 获取身份源详情 * @description 通过 身份源 ID，获取身份源详情，可以指定 租户 ID 筛选。 * @param id 身份源 ID * @param tenantId 租户 ID * @param appId 应用 ID * @param type 身份源类型 * @returns ExtIdpDetailSingleRespDto

func (*ManagementClient) GetExternalUserResourceStruct added in v3.0.5 

func (client *ManagementClient) GetExternalUserResourceStruct(reqDto *dto.GetExternalUserResourceStructDto) *dto.GetExternalUserResourceStructRespDto
  • @summary 获取外部用户授权资源的结构列表
  • @description
  • ## 描述
  • 当你需要获取外部用户（通过参数`externalId`参数传递外部用户 ID）拥有某一资源的权限并且需要这个资源的结构信息（树类型资源返回树结构，数组类型资源返回数组、字符串类型返回字符串）则可以使用此接口。
  • ## 请求示例
  • ### 获取用户授权字符串数据资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "externalId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleStrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleStrResourceCode",
  • "resourceType": "STRING",
  • "strResourceAuthAction":{
  • "value": "strTestValue",
  • "actions": ["get","delete"]
  • }
  • }
  • }
  • ``` * *
  • ### 获取用户授权数据数组资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "externalId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleArrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleArrResourceCode",
  • "resourceType": "ARRAY",
  • "arrResourceAuthAction":{
  • "values": ["arrTestValue1","arrTestValue2","arrTestValue3"],
  • "actions": ["get","delete"]
  • }
  • }
  • }
  • ``` * *
  • ### 获取用户授权树数据资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "externalId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleArrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleArrResourceCode",
  • "resourceType": "TREE",
  • "treeResourceAuthAction":{
  • "nodeAuthActionList":[{
  • "code": "tree11",
  • "name": "tree11",
  • "value": "test11Value",
  • "actions": ["get","delete"],
  • "children": [{
  • "code": "tree111",
  • "name": "tree111",
  • "value": "test111Value",
  • "actions": ["update","read"],
  • }]
  • },{
  • "code": "tree22",
  • "name": "tree22",
  • "value": "test22Value",
  • "actions": ["get","delete"]
  • }]
  • }
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns GetExternalUserResourceStructRespDto

func (*ManagementClient) GetGlobalMfaSettings 

func (client *ManagementClient) GetGlobalMfaSettings() *dto.MFASettingsRespDto

* @summary 获取全局多因素认证配置 * @description 无需传参获取全局多因素认证配置 * @returns MFASettingsRespDto

func (*ManagementClient) GetGroup 

func (client *ManagementClient) GetGroup(reqDto *dto.GetGroupDto) *dto.GroupSingleRespDto

* @summary 获取分组详情 * @description 通过分组 code，获取分组详情。 * @param code 分组 code * @param withCustomData 是否获取自定义数据 * @returns GroupSingleRespDto

func (*ManagementClient) GetGroupAuthorizedResources 

func (client *ManagementClient) GetGroupAuthorizedResources(reqDto *dto.GetGroupAuthorizedResourcesDto) *dto.AuthorizedResourceListRespDto

* @summary 获取分组被授权的资源列表 * @description 通过分组 code，获取分组被授权的资源列表，可以通过资源类型、权限分组 code 筛选。 * @param code 分组 code * @param namespace 所属权限分组(权限空间)的 Code * @param resourceType 资源类型 * @returns AuthorizedResourceListRespDto

func (*ManagementClient) GetGroupsOfPublicAccount added in v3.0.14 

func (client *ManagementClient) GetGroupsOfPublicAccount(reqDto *dto.GetGroupsOfPublicAccountDto) *dto.GroupPaginatedRespDto
  • @summary 获取公共账号分组列表
  • @description 通过公共账号 ID，获取公共账号分组列表，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns GroupPaginatedRespDto

func (*ManagementClient) GetImportTemplate added in v3.0.14 

func (client *ManagementClient) GetImportTemplate(reqDto *dto.GetImportTemplateDto) *dto.GetImportTemplateResDto

* @summary 获取导入模板 * @description 获取导入模板 * @param modelId 功能 id * @returns GetImportTemplateResDto

func (*ManagementClient) GetMauPeriodUsageHistory 

func (client *ManagementClient) GetMauPeriodUsageHistory(reqDto *dto.GetMauPeriodUsageHistoryDto) *dto.CostGetMauPeriodUsageHistoryRespDto

* @summary 获取 MAU 使用记录 * @description 获取当前用户池 MAU 使用记录 * @param startTime 起始时间（年月日） * @param endTime 截止时间（年月日） * @returns CostGetMauPeriodUsageHistoryRespDto

func (*ManagementClient) GetMfaTriggerData added in v3.0.14 

func (client *ManagementClient) GetMfaTriggerData(reqDto *dto.GetMfaTriggerDataDto) *dto.GetMapInfoRespDto
  • @summary 获取应用下用户 MFA 触发数据
  • @description 获取应用下用户 MFA 触发数据。
  • @param appId 所属应用 ID
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns GetMapInfoRespDto

func (*ManagementClient) GetModel added in v3.0.14 

func (client *ManagementClient) GetModel(reqDto *dto.GetModelDto) *dto.FunctionModelResDto

* @summary 获取数据对象详情 * @description 利用功能 id ，获取数据对象的详细信息 * @param id 功能 id 可以从控制台页面获取 * @returns FunctionModelResDto

func (*ManagementClient) GetMultipleTenantAdmin added in v3.0.14 

func (client *ManagementClient) GetMultipleTenantAdmin(reqDto *dto.GetMultipleTenantAdminDto) *dto.MultipleTenantAdminPaginatedRespDto

* @summary 获取多租户管理员用户列表 * @description 根据用户池 ID 获取某个用户池内拥有多租户管理权限的用户列表 * @param userId 用户 ID * @returns MultipleTenantAdminPaginatedRespDto

func (*ManagementClient) GetNamespace 

func (client *ManagementClient) GetNamespace(reqDto *dto.GetNamespaceDto) *dto.NamespaceRespDto

* @summary 获取权限分组详情 * @description 通过权限分组唯一标志符(Code)，获取权限分组详情。 * @param code 权限分组唯一标志符 * @returns NamespaceRespDto

func (*ManagementClient) GetNamespacesBatch 

func (client *ManagementClient) GetNamespacesBatch(reqDto *dto.GetNamespacesBatchDto) *dto.NamespaceListRespDto

* @summary 批量获取权限分组详情 * @description 分别通过权限分组唯一标志符(Code)，批量获取权限分组详情。 * @param codeList 权限分组 code 列表，批量可以使用逗号分隔 * @returns NamespaceListRespDto

func (*ManagementClient) GetOrderDetail 

func (client *ManagementClient) GetOrderDetail(reqDto *dto.GetOrderDetailDto) *dto.CostGetOrderDetailRespDto

* @summary 获取订单详情 * @description 获取当前用户池订单详情 * @param orderNo 订单号 * @returns CostGetOrderDetailRespDto

func (*ManagementClient) GetOrderPayDetail 

func (client *ManagementClient) GetOrderPayDetail(reqDto *dto.GetOrderPayDetailDto) *dto.CostGetOrderPayDetailRespDto

* @summary 获取订单支付明细 * @description 获取当前用户池订单支付明细 * @param orderNo 订单号 * @returns CostGetOrderPayDetailRespDto

func (*ManagementClient) GetOrders 

func (client *ManagementClient) GetOrders(reqDto *dto.GetOrdersDto) *dto.CostGetOrdersRespDto

* @summary 获取订单列表 * @description 获取当前用户池订单列表 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns CostGetOrdersRespDto

func (*ManagementClient) GetOrganization 

func (client *ManagementClient) GetOrganization(reqDto *dto.GetOrganizationDto) *dto.OrganizationSingleRespDto

* @summary 获取组织机构详情 * @description 获取组织机构详情 * @param organizationCode 组织 Code（organizationCode） * @param withCustomData 是否获取自定义数据 * @param withPost 是否获取 部门信息 * @param tenantId 租户 ID * @returns OrganizationSingleRespDto

func (*ManagementClient) GetOrganizationsBatch 

func (client *ManagementClient) GetOrganizationsBatch(reqDto *dto.GetOrganizationBatchDto) *dto.OrganizationListRespDto

* @summary 批量获取组织机构详情 * @description 批量获取组织机构详情 * @param organizationCodeList 组织 Code（organizationCode）列表 * @param withCustomData 是否获取自定义数据 * @param withPost 是否获取 部门信息 * @param tenantId 租户 ID * @returns OrganizationListRespDto

func (*ManagementClient) GetOtpSecretByUser added in v3.0.6 

func (client *ManagementClient) GetOtpSecretByUser(reqDto *dto.GetOtpSecretByUserDto) *dto.GetOtpSecretRespDto
  • @summary 获取用户绑定 OTP 的秘钥
  • @description 通过用户 ID，获取用户绑定 OTP 的秘钥。可以选择指定用户 ID 类型等。
  • @param userId 用户 ID
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns GetOtpSecretRespDto

func (*ManagementClient) GetParentDepartment 

func (client *ManagementClient) GetParentDepartment(reqDto *dto.GetParentDepartmentDto) *dto.DepartmentSingleRespDto

* @summary 获取父部门信息 * @description 通过组织 code、部门 ID，获取父部门信息，可以选择获取自定义数据等。 * @param organizationCode 组织 code * @param departmentId 部门 ID * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param withCustomData 是否获取自定义数据 * @param tenantId 租户 ID * @returns DepartmentSingleRespDto

func (*ManagementClient) GetPermissionNamespace added in v3.0.4 

func (client *ManagementClient) GetPermissionNamespace(reqDto *dto.GetPermissionNamespaceDto) *dto.GetPermissionNamespaceResponseDto

* @summary 获取权限空间详情 * @description 通过权限空间唯一标志符(Code)，获取权限空间详情。 * @param code 权限空间 Code * @returns GetPermissionNamespaceResponseDto

func (*ManagementClient) GetPermissionNamespacesBatch added in v3.0.4 

func (client *ManagementClient) GetPermissionNamespacesBatch(reqDto *dto.GetPermissionNamespacesBatchDto) *dto.GetPermissionNamespaceListResponseDto

* @summary 批量获取权限空间详情列表 * @description 分别通过权限空间唯一标志符(Code)，获取权限空间详情。 * @param codes 权限空间 code 列表，批量可以使用逗号分隔 * @returns GetPermissionNamespaceListResponseDto

func (*ManagementClient) GetPipelineFunction 

func (client *ManagementClient) GetPipelineFunction(reqDto *dto.GetPipelineFunctionDto) *dto.PipelineFunctionSingleRespDto

* @summary 获取 Pipeline 函数详情 * @description 获取 Pipeline 函数详情 * @param funcId Pipeline 函数 ID * @returns PipelineFunctionSingleRespDto

func (*ManagementClient) GetPipelineLogs 

func (client *ManagementClient) GetPipelineLogs(reqDto *dto.GetPipelineLogsDto) *dto.PipelineFunctionPaginatedRespDto

* @summary 获取 Pipeline 日志 * @description 获取 Pipeline * @param funcId Pipeline 函数 ID * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns PipelineFunctionPaginatedRespDto

func (*ManagementClient) GetPost added in v3.0.14 

func (client *ManagementClient) GetPost(reqDto *dto.GetPostDto) *dto.CreatePostDto

* @summary 获取岗位 * @description 获取岗位 * @param code 岗位 code * @param withCustomData 是否获取自定义数据 * @returns CreatePostDto

func (*ManagementClient) GetPostById added in v3.0.14 

func (client *ManagementClient) GetPostById(reqDto *dto.GetPostByIdListDto) *dto.PostRespDto

* @summary 获取岗位信息 * @description 根据岗位 id 获取岗位详情 * @param requestBody * @returns PostRespDto

func (*ManagementClient) GetPostOfPublicUser added in v3.0.14 

func (client *ManagementClient) GetPostOfPublicUser(reqDto *dto.GetPostOfPublicAccountDto) *dto.CreatePostDto

* @summary 获取公共账号的岗位 * @description 获取公共账号的岗位 * @param userId 用户 id * @returns CreatePostDto

func (*ManagementClient) GetPublicAccount added in v3.0.14 

func (client *ManagementClient) GetPublicAccount(reqDto *dto.GetPublicAccountDto) *dto.PublicAccountSingleRespDto
  • @summary 获取公共账号信息
  • @description 通过公共账号用户 ID，获取公共账号详情，可以选择获取自定义数据、选择指定用户 ID 类型等。
  • @param userId 公共账号用户 ID
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段 *
  • @param withCustomData 是否获取自定义数据
  • @param withDepartmentIds 是否获取部门 ID 列表
  • @returns PublicAccountSingleRespDto

func (*ManagementClient) GetPublicAccountBatch added in v3.0.14 

func (client *ManagementClient) GetPublicAccountBatch(reqDto *dto.GetPublicAccountBatchDto) *dto.PublicAccountListRespDto
  • @summary 批量获取公共账号信息
  • @description 通过公共账号用户 ID 列表，批量获取公共账号信息，可以选择获取自定义数据、选择指定用户 ID 类型等。
  • @param userIds 公共账号用户 ID 数组
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段 *
  • @param withCustomData 是否获取自定义数据
  • @param withDepartmentIds 是否获取部门 ID 列表
  • @returns PublicAccountListRespDto

func (*ManagementClient) GetPublicAccountDepartments added in v3.0.14 

func (client *ManagementClient) GetPublicAccountDepartments(reqDto *dto.GetDepartmentsOfPublicAccountDto) *dto.UserDepartmentPaginatedRespDto
  • @summary 获取公共账号的部门列表
  • @description 通过用户 ID，获取用户部门列表，支持分页，可以选择获取自定义数据、选择指定用户 ID 类型、增序或降序等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param withCustomData 是否获取自定义数据
  • @param withDepartmentPaths 是否获取部门路径
  • @param sortBy 排序依据，如 部门创建时间、加入部门时间、部门名称、部门标志符
  • @param orderBy 增序或降序
  • @returns UserDepartmentPaginatedRespDto

func (*ManagementClient) GetPublicAccountOfGroups added in v3.0.14 

func (client *ManagementClient) GetPublicAccountOfGroups(reqDto *dto.SetUserGroupsDto) *dto.IsSuccessRespDto

* @summary 公共账号添加批量分组 * @description 公共账号通过分组 ID 添加批量分组 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) GetPublicAccountRoles added in v3.0.14 

func (client *ManagementClient) GetPublicAccountRoles(reqDto *dto.GetRolesOfPublicAccountDto) *dto.PublicAccountPaginatedRespDto
  • @summary 获取公共账号的角色列表
  • @description 通过用户 ID，获取用户角色列表，可以选择所属权限分组 code、选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param namespace 所属权限分组(权限空间)的 code
  • @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetPublicAccountsOfDepartment added in v3.0.14 

func (client *ManagementClient) GetPublicAccountsOfDepartment(reqDto *dto.GetPublicAccountsOfDepartmentDto) *dto.PublicAccountPaginatedRespDto

* @summary 获取部门的公共账号列表 * @description 通过部门 ID，获取用户的公共账号列表。 * @param departmentId 部门 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetPublicAccountsOfGroup added in v3.0.14 

func (client *ManagementClient) GetPublicAccountsOfGroup(reqDto *dto.GetPublicAccountsOfGroupDto) *dto.PublicAccountPaginatedRespDto

* @summary 获取分组的公共账号列表 * @description 通过分组 ID，获取用户的公共账号列表。 * @param groupId 分组 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetPublicAccountsOfPost added in v3.0.14 

func (client *ManagementClient) GetPublicAccountsOfPost(reqDto *dto.GetPublicAccountsOfPostDto) *dto.PublicAccountPaginatedRespDto

* @summary 获取岗位的公共账号列表 * @description 通过岗位 ID，获取用户的公共账号列表。 * @param postId 岗位 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetPublicAccountsOfRole added in v3.0.14 

func (client *ManagementClient) GetPublicAccountsOfRole(reqDto *dto.GetPublicAccountsOfRoleDto) *dto.PublicAccountPaginatedRespDto

* @summary 获取角色的公共账号列表 * @description 通过角色 ID，获取用户的公共账号列表。 * @param roleId 角色 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetPublicAccountsOfUser added in v3.0.14 

func (client *ManagementClient) GetPublicAccountsOfUser(reqDto *dto.GetPublicAccountsOfUserDto) *dto.PublicAccountPaginatedRespDto

* @summary 获取用户的公共账号列表 * @description 通过用户 ID，获取用户的公共账号列表。 * @param userId 用户 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetRelationInfo added in v3.0.14 

func (client *ManagementClient) GetRelationInfo(reqDto *dto.GetRelationInfoDto) *dto.CommonResponseDto

* @summary 获取关联数据详情 * @description 获取关联数据详情 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) GetRelationValue added in v3.0.14 

func (client *ManagementClient) GetRelationValue(reqDto *dto.GetRowRelationDto) *dto.RelationValueListResDto

* @summary 获取行关联数据 * @description 获取行关联数据 * @param modelId 功能 id * @param fieldId 字段 id * @param rowId 行 id * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns RelationValueListResDto

func (*ManagementClient) GetResource 

func (client *ManagementClient) GetResource(reqDto *dto.GetResourceDto) *dto.ResourceRespDto

* @summary 获取资源详情 * @description 根据筛选条件，获取资源详情。 * @param code 资源唯一标志符 * @param namespace 所属权限分组(权限空间)的 Code * @returns ResourceRespDto

func (*ManagementClient) GetResourceAuthorizedTargets 

func (client *ManagementClient) GetResourceAuthorizedTargets(reqDto *dto.GetResourceAuthorizedTargetsDto) *dto.GetResourceAuthorizedTargetRespDto

* @summary 获取资源被授权的主体 * @description 获取资源被授权的主体 * @param requestBody * @returns GetResourceAuthorizedTargetRespDto

func (*ManagementClient) GetResourcesBatch 

func (client *ManagementClient) GetResourcesBatch(reqDto *dto.GetResourcesBatchDto) *dto.ResourceListRespDto

* @summary 批量获取资源详情 * @description 根据筛选条件，批量获取资源详情。 * @param codeList 资源 code 列表，批量可以使用逗号分隔 * @param namespace 所属权限分组(权限空间)的 Code * @returns ResourceListRespDto

func (*ManagementClient) GetRole 

func (client *ManagementClient) GetRole(reqDto *dto.GetRoleDto) *dto.RoleSingleRespDto

* @summary 获取角色详情 * @description 通过权限分组内角色 code，获取角色详情。 * @param code 权限分组(权限空间)内角色的唯一标识符 * @param namespace 所属权限分组(权限空间)的 Code * @returns RoleSingleRespDto

func (*ManagementClient) GetRoleAuthorizedResources 

func (client *ManagementClient) GetRoleAuthorizedResources(reqDto *dto.GetRoleAuthorizedResourcesDto) *dto.RoleAuthorizedResourcePaginatedRespDto

* @summary 获取角色被授权的资源列表 * @description 通过权限分组内角色 code，获取角色被授权的资源列表。 * @param code 权限分组内角色的唯一标识符 * @param namespace 所属权限分组的 code * @param resourceType 资源类型，如 数据、API、按钮、菜单 * @returns RoleAuthorizedResourcePaginatedRespDto

func (*ManagementClient) GetRow added in v3.0.14 

func (client *ManagementClient) GetRow(reqDto *dto.GetRowDto) *dto.FunctionModelValueResDto

* @summary 获取数据对象行信息 * @description 获取数据对象行信息 * @param modelId 功能 id * @param rowId 行 id * @param showFieldId 返回结果中是否使用字段 id 作为 key * @returns FunctionModelValueResDto

func (*ManagementClient) GetRowBatch added in v3.0.14 

func (client *ManagementClient) GetRowBatch(reqDto *dto.GetRowBatchDto) *dto.MetadataListResDto

* @summary 批量获取行信息 * @description 批量获取行信息 * @param requestBody * @returns MetadataListResDto

func (*ManagementClient) GetRowByValue added in v3.0.14 

func (client *ManagementClient) GetRowByValue(reqDto *dto.GetRowByValueDto) *dto.FunctionModelValueResDto

* @summary 根据属性值获取数据对象行信息 * @description 根据属性值获取数据对象行信息，只允许通过唯一性字段进行精确查询。 * @param modelId 功能 id * @param key 字段 key * @param value 字段值 * @param showFieldId 返回结果中是否使用字段 id 作为 key * @returns FunctionModelValueResDto

func (*ManagementClient) GetSecuritySettings 

func (client *ManagementClient) GetSecuritySettings() *dto.SecuritySettingsRespDto

* @summary 获取安全配置 * @description 无需传参获取安全配置 * @returns SecuritySettingsRespDto

func (*ManagementClient) GetSyncJob 

func (client *ManagementClient) GetSyncJob(reqDto *dto.GetSyncJobDto) *dto.SyncJobSingleRespDto

* @summary 获取同步作业详情 * @description 获取同步作业详情 * @param syncJobId 同步作业 ID * @returns SyncJobSingleRespDto

func (*ManagementClient) GetSyncTask 

func (client *ManagementClient) GetSyncTask(reqDto *dto.GetSyncTaskDto) *dto.SyncTaskSingleRespDto

* @summary 获取同步任务详情 * @description 获取同步任务详情 * @param syncTaskId 同步任务 ID * @returns SyncTaskSingleRespDto

func (*ManagementClient) GetTenant added in v3.0.14 

func (client *ManagementClient) GetTenant(reqDto *dto.GetTenantDto) *dto.TenantSingleRespDto

* @summary 获取租户详情 * @description 根据租户 ID 获取租户详情 * @param tenantId 租户 ID * @param withMembersCount 是否增加返回租户成员统计 * @param withAppDetail 增加返回租户关联应用简单信息 * @param withCreatorDetail 增加返回租户下创建者简单信息 * @param withSourceAppDetail 增加返回租户来源应用简单信息 * @returns TenantSingleRespDto

func (*ManagementClient) GetTenantByCode added in v3.0.14 

func (client *ManagementClient) GetTenantByCode(reqDto *dto.GetTenantByCodeDto) *dto.TenantSingleRespDto

* @summary 获取租户详情 * @description 根据租户 Code 获取租户详情 * @param code 租户 Code * @returns TenantSingleRespDto

func (*ManagementClient) GetTenantCooperator added in v3.0.14 

func (client *ManagementClient) GetTenantCooperator(reqDto *dto.GetTenantCooperatorDto) *dto.TenantCooperatorSingleRespDto

* @summary 获取一个协调管理员 * @description 根据用户池 ID 获取某个协调管理员的列表 * @param userId 用户 ID * @returns TenantCooperatorSingleRespDto

func (*ManagementClient) GetTenantCooperatorMenu added in v3.0.14 

func (client *ManagementClient) GetTenantCooperatorMenu(reqDto *dto.GetTenantCooperatorMenuDto) *dto.TenantCooperatorSingleRespDto

* @summary 获取一个协调管理员拥有的列表 * @description 根据用户池 ID 获取某个协调管理员的列表 * @param userId 用户 ID * @returns TenantCooperatorSingleRespDto

func (*ManagementClient) GetTenantLittleInfo added in v3.0.14 

func (client *ManagementClient) GetTenantLittleInfo(reqDto *dto.GetTenantLittleInfoDto) *dto.TenantSingleRespDto

* @summary 获取租户一点点的信息 * @description 根据租户 ID 获取租户一点点的详情 * @param tenantId 租户 ID * @param withMembersCount 是否增加返回租户成员统计 * @param withAppDetail 增加返回租户关联应用简单信息 * @param withCreatorDetail 增加返回租户下创建者简单信息 * @param withSourceAppDetail 增加返回租户来源应用简单信息 * @returns TenantSingleRespDto

func (*ManagementClient) GetTenantUser added in v3.0.14 

func (client *ManagementClient) GetTenantUser(reqDto *dto.GetTenantUserDto) *dto.TenantUserSingleRespDto

* @summary 获取单个租户成员 * @description 根据用户 ID 或租户成员 ID 获取租户成员信息 * @param tenantId 租户 ID * @param linkUserId 关联的用户池级别的用户 ID * @param memberId 租户成员 ID * @returns TenantUserSingleRespDto

func (*ManagementClient) GetUsageInfo 

func (client *ManagementClient) GetUsageInfo() *dto.CostGetCurrentUsageRespDto

* @summary 获取用量详情 * @description 获取当前用户池用量详情。 * @returns CostGetCurrentUsageRespDto

func (*ManagementClient) GetUser 

func (client *ManagementClient) GetUser(reqDto *dto.GetUserDto) *dto.UserSingleRespDto
  • @summary 获取用户信息
  • @description 通过用户 ID，获取用户详情，可以选择获取自定义数据、identities、选择指定用户 ID 类型等。
  • @param userId 用户 ID
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param flatCustomData 是否拍平扩展字段
  • @param withCustomData 是否获取自定义数据
  • @param withPost 是否获取 部门信息
  • @param withIdentities 是否获取 identities
  • @param withDepartmentIds 是否获取部门 ID 列表
  • @returns UserSingleRespDto

func (*ManagementClient) GetUserAccessibleApps 

func (client *ManagementClient) GetUserAccessibleApps(reqDto *dto.GetUserAccessibleAppsDto) *dto.AppListRespDto
  • @summary 获取用户可访问的应用
  • @description 通过用户 ID，获取用户可访问的应用，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns AppListRespDto

func (*ManagementClient) GetUserActionLogs 

func (client *ManagementClient) GetUserActionLogs(reqDto *dto.GetUserActionLogsDto) *dto.UserActionLogRespDto

* @summary 获取用户行为日志 * @description 可以选择请求 ID、客户端 IP、用户 ID、应用 ID、开始时间戳、请求是否成功、分页参数来获取用户行为日志 * @param requestBody * @returns UserActionLogRespDto

func (*ManagementClient) GetUserAuthorizedApps 

func (client *ManagementClient) GetUserAuthorizedApps(reqDto *dto.GetUserAuthorizedAppsDto) *dto.AppListRespDto
  • @summary 获取用户授权的应用
  • @description 通过用户 ID，获取用户授权的应用，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns AppListRespDto

func (*ManagementClient) GetUserAuthorizedResources 

func (client *ManagementClient) GetUserAuthorizedResources(reqDto *dto.GetUserAuthorizedResourcesDto) *dto.AuthorizedResourcePaginatedRespDto
  • @summary 获取用户被授权的所有资源
  • @description 通过用户 ID，获取用户被授权的所有资源，可以选择指定用户 ID 类型等，用户被授权的资源是用户自身被授予、通过分组继承、通过角色继承、通过组织机构继承的集合。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param namespace 所属权限分组(权限空间)的 Code
  • @param resourceType 资源类型，如 数据、API、菜单、按钮
  • @returns AuthorizedResourcePaginatedRespDto

func (*ManagementClient) GetUserBaseFields 

func (client *ManagementClient) GetUserBaseFields() *dto.CustomFieldListRespDto

* @summary 获取用户内置字段列表 * @description 获取用户内置的字段列表 * @returns CustomFieldListRespDto

func (*ManagementClient) GetUserBatch 

func (client *ManagementClient) GetUserBatch(reqDto *dto.GetUserBatchDto) *dto.UserListRespDto
  • @summary 批量获取用户信息
  • @description 通过用户 ID 列表，批量获取用户信息，可以选择获取自定义数据、identities、选择指定用户 ID 类型等。
  • @param userIds 用户 ID 数组
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param withCustomData 是否获取自定义数据
  • @param flatCustomData 是否拍平扩展字段
  • @param withIdentities 是否获取 identities
  • @param withDepartmentIds 是否获取部门 ID 列表
  • @returns UserListRespDto

func (*ManagementClient) GetUserDepartments 

func (client *ManagementClient) GetUserDepartments(reqDto *dto.GetUserDepartmentsDto) *dto.UserDepartmentPaginatedRespDto
  • @summary 获取用户部门列表
  • @description 通过用户 ID，获取用户部门列表，支持分页，可以选择获取自定义数据、选择指定用户 ID 类型、增序或降序等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param withCustomData 是否获取自定义数据
  • @param withDepartmentPaths 是否获取部门路径
  • @param sortBy 排序依据，如 部门创建时间、加入部门时间、部门名称、部门标志符
  • @param orderBy 增序或降序
  • @returns UserDepartmentPaginatedRespDto

func (*ManagementClient) GetUserGroups 

func (client *ManagementClient) GetUserGroups(reqDto *dto.GetUserGroupsDto) *dto.GroupPaginatedRespDto
  • @summary 获取用户分组列表
  • @description 通过用户 ID，获取用户分组列表，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns GroupPaginatedRespDto

func (*ManagementClient) GetUserIdentities 

func (client *ManagementClient) GetUserIdentities(reqDto *dto.GetUserIdentitiesDto) *dto.IdentityListRespDto
  • @summary 获取用户的外部身份源
  • @description 通过用户 ID，获取用户的外部身份源、选择指定用户 ID 类型。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns IdentityListRespDto

func (*ManagementClient) GetUserLoggedinApps 

func (client *ManagementClient) GetUserLoggedinApps(reqDto *dto.GetUserLoggedinAppsDto) *dto.UserLoggedInAppsListRespDto
  • @summary 获取用户曾经登录过的应用
  • @description 通过用户 ID，获取用户曾经登录过的应用，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns UserLoggedInAppsListRespDto

func (*ManagementClient) GetUserLoggedinIdentities 

func (client *ManagementClient) GetUserLoggedinIdentities(reqDto *dto.GetUserLoggedInIdentitiesDto) *dto.UserLoggedInIdentitiesRespDto
  • @summary 获取用户曾经登录过的身份源
  • @description 通过用户 ID，获取用户曾经登录过的身份源，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns UserLoggedInIdentitiesRespDto

func (*ManagementClient) GetUserLoginHistory 

func (client *ManagementClient) GetUserLoginHistory(reqDto *dto.GetUserLoginHistoryDto) *dto.UserLoginHistoryPaginatedRespDto
  • @summary 获取用户的登录历史记录
  • @description 通过用户 ID，获取用户登录历史记录，支持分页，可以选择指定用户 ID 类型、应用 ID、开始与结束时间戳等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param appId 应用 ID
  • @param clientIp 客户端 IP
  • @param start 开始时间戳（毫秒）
  • @param end 结束时间戳（毫秒）
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @returns UserLoginHistoryPaginatedRespDto

func (*ManagementClient) GetUserMfaInfo 

func (client *ManagementClient) GetUserMfaInfo(reqDto *dto.GetUserMfaInfoDto) *dto.UserMfaSingleRespDto
  • @summary 获取用户 MFA 绑定信息
  • @description 通过用户 ID，获取用户 MFA 绑定信息，可以选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns UserMfaSingleRespDto

func (*ManagementClient) GetUserMfaStatus added in v3.0.14 

func (client *ManagementClient) GetUserMfaStatus(reqDto *dto.GetMfaStatusDto) *dto.GetMapInfoRespDto
  • @summary 获取用户 MFA 状态
  • @description 获取用户 MFA 状态，即 MFA 触发数据。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns GetMapInfoRespDto

func (*ManagementClient) GetUserPasswordCiphertext added in v3.0.14 

func (client *ManagementClient) GetUserPasswordCiphertext(reqDto *dto.GetUserPasswordCiphertextDto) *dto.GetUserPasswordCiphertextRespDto

* @summary 获取用户自定义加密的密码 * @description 此功能主要是用户在控制台配置加基于 RSA、SM2 等加密的密钥后，加密用户的密码。 * @param requestBody * @returns GetUserPasswordCiphertextRespDto

func (*ManagementClient) GetUserPermissionList added in v3.0.4 

func (client *ManagementClient) GetUserPermissionList(reqDto *dto.GetUserPermissionListDto) *dto.GetUserPermissionListRespDto
  • @summary 获取用户权限列表
  • @description
  • ## 描述
  • 该接口用于查询某些用户在某些权限空间的数据资源的权限数据。
  • 我们的鉴权接口针对不同的鉴权场景有多种，区别在于在所处的场景下能够传递的参数列表以及不同形式的出参，**当你需要查询某些用户的所有权限时**可以使用此接口，
  • ## 注意
  • 接口提供了两个数组类型的入参`userIds`和`namespaceCodes`来支持批量查询（注意：namespaceCodes 是可选的）。
  • ## 场景举例
  • 假如你的业务场景是用户登录后能看到他所有可以访问或者进行其他操作的文档、人员信息、设备信息等资源，那么你可以在用户登录后调用此接口查询用户的所有权限。
  • ## 请求示例
  • ### 查询单个用户权限列表示例
  • 注意：在此接口的返回参数中，树类型的数据资源权限返回是按照**路径**的方式返回的
  • - 入参 *
  • ```json
  • {
  • "userIds": [
  • "6301ceaxxxxxxxxxxx27478"
  • ]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data": {
  • "userPermissionList": [
  • {
  • "userId": "6301ceaxxxxxxxxxxx27478",
  • "namespaceCode": "examplePermissionNamespace",
  • "resourceList": [
  • {
  • "resourceCode": "strCode",
  • "resourceType": "STRING",
  • "strAuthorize": {
  • "value": "示例字符串资源",
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • },
  • {
  • "resourceCode": "arrayCode",
  • "resourceType": "ARRAY",
  • "arrAuthorize": {
  • "values": [
  • "示例数据资源1",
  • "示例数据资源2"
  • ],
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • },
  • {
  • "resourceCode": "treeCode",
  • "resourceType": "TREE",
  • "treeAuthorize": {
  • "authList": [
  • {
  • "nodePath": "/treeChildrenCode/treeChildrenCode1",
  • "nodeActions": [
  • "read",
  • "get"
  • ],
  • "nodeName": "treeChildrenName1",
  • "nodeValue": "treeChildrenValue1"
  • },
  • {
  • "nodePath": "/treeChildrenCode/treeChildrenCode2",
  • "nodeActions": [
  • "read",
  • "get"
  • ],
  • "nodeName": "treeChildrenName2",
  • "nodeValue": "treeChildrenValue2"
  • },
  • {
  • "nodePath": "/treeChildrenCode/treeChildrenCode3",
  • "nodeActions": [
  • "read"
  • ],
  • "nodeName": "treeChildrenName3",
  • "nodeValue": "treeChildrenValue3"
  • }
  • ]
  • }
  • }
  • ]
  • }
  • ]
  • }
  • }
  • ``` *
  • ### 查询多个用户权限列表示例 *
  • - 入参 *
  • ```json
  • {
  • "userIds": [
  • "6301ceaxxxxxxxxxxx27478",
  • "6121ceaxxxxxxxxxxx27312"
  • ]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data": {
  • "userPermissionList": [
  • {
  • "userId": "6301ceaxxxxxxxxxxx27478",
  • "namespaceCode": "examplePermissionNamespace1",
  • "resourceList": [
  • {
  • "resourceCode": "strCode",
  • "resourceType": "STRING",
  • "strAuthorize": {
  • "value": "示例字符串资源",
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • }
  • ]
  • },
  • {
  • "userId": "6121ceaxxxxxxxxxxx27312",
  • "namespaceCode": "examplePermissionNamespace2",
  • "resourceList": [
  • {
  • "resourceCode": "arrayCode",
  • "resourceType": "ARRAY",
  • "arrAuthorize": {
  • "values": [
  • "示例数组资源1",
  • "示例数组资源2"
  • ],
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • }
  • ]
  • }
  • ]
  • }
  • }
  • ``` *
  • ### 查询多个用户在多个权限空间下权限列表示例 *
  • - 入参 *
  • ```json
  • {
  • "userIds": [
  • "6301ceaxxxxxxxxxxx27478",
  • "6121ceaxxxxxxxxxxx27312"
  • ],
  • "namespaceCodes": [
  • "examplePermissionNamespace1",
  • "examplePermissionNamespace2"
  • ]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data": {
  • "userPermissionList": [
  • {
  • "userId": "6301ceaxxxxxxxxxxx27478",
  • "namespaceCode": "examplePermissionNamespace1",
  • "resourceList": [
  • {
  • "resourceCode": "strCode1",
  • "resourceType": "STRING",
  • "strAuthorize": {
  • "value": "示例字符串资源",
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • }
  • ]
  • },
  • {
  • "userId": "6121ceaxxxxxxxxxxx27312",
  • "namespaceCode": "examplePermissionNamespace2",
  • "resourceList": [
  • {
  • "resourceCode": "arrayCode",
  • "resourceType": "ARRAY",
  • "arrAuthorize": {
  • "values": [
  • "示例数组资源1",
  • "示例数组资源2"
  • ],
  • "actions": [
  • "read",
  • "post",
  • "get",
  • "write"
  • ]
  • }
  • }
  • ]
  • }
  • ]
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns GetUserPermissionListRespDto

func (*ManagementClient) GetUserPost added in v3.0.14 

func (client *ManagementClient) GetUserPost(reqDto *dto.GetUserPostDto) *dto.CreatePostDto

* @deprecated * @summary 获取用户关联岗位 * @description 此接口只会返回一个岗位，已废弃，请使用 /api/v3/get-user-posts 接口 * @param userId 用户 id * @param withCustomData 是否获取自定义数据 * @returns CreatePostDto

func (*ManagementClient) GetUserPosts added in v3.0.14 

func (client *ManagementClient) GetUserPosts(reqDto *dto.GetUserPostsDto) *dto.PostListRespDto

* @deprecated * @summary 获取用户关联岗位 * @description 获取用户关联的所有岗位 * @param userId 用户 id * @param withCustomData 是否获取自定义数据 * @returns PostListRespDto

func (*ManagementClient) GetUserPrincipalAuthenticationInfo 

func (client *ManagementClient) GetUserPrincipalAuthenticationInfo(reqDto *dto.GetUserPrincipalAuthenticationInfoDto) *dto.PrincipalAuthenticationInfoPaginatedRespDto
  • @summary 获取用户实名认证信息
  • @description 通过用户 ID，获取用户实名认证信息，可以选择指定用户 ID 类型。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns PrincipalAuthenticationInfoPaginatedRespDto

func (*ManagementClient) GetUserResourcePermissionList added in v3.0.4 

func (client *ManagementClient) GetUserResourcePermissionList(reqDto *dto.GetUserResourcePermissionListDto) *dto.GetUserResourcePermissionListRespDto
  • @summary 获取用户指定资源权限列表（推荐）
  • @description
  • ## 描述
  • 当你需要查询某一用户拥有指定的资源列表的权限时，可以使用此接口。
  • ## 注意
  • 该接口需要你传递指定的资源 code（如果是树类型资源则需要传递节点的完整 code 路径），此接口性能更佳，推荐使用。
  • ## 请求示例
  • ### 获取用户字符串和数组资源权限示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "resources":["strResourceCode1", "arrayResourceCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • { *
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "permissionList": [{
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["read","get"],
  • "resource": "strResourceCode1"
  • },{
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["read","update","delete"],
  • "resource": "arrayResourceCode1"
  • }]
  • }
  • }
  • ``` *
  • ### 获取用户树资源权限示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "resources":["treeResourceCode1/StructCode1/resourceStructChildrenCode1", "treeResourceCode2/StructCode1/resourceStructChildrenCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "permissionList": [{
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["read", "update", "delete"],
  • "resource": "treeResourceCode1/StructCode1/resourceStructChildrenCode1"
  • },{
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["read", "get", "delete"],
  • "resource": "treeResourceCode2/StructCode1/resourceStructChildrenCode1"
  • }]
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns GetUserResourcePermissionListRespDto

func (*ManagementClient) GetUserResourceStruct added in v3.0.5 

func (client *ManagementClient) GetUserResourceStruct(reqDto *dto.GetUserResourceStructDto) *dto.GetUserResourceStructRespDto
  • @summary 获取用户授权资源的结构列表
  • @description
  • ## 描述
  • 当你需要获取用户拥有某一资源的权限并且需要这个资源的结构信息（树类型资源返回树结构，数组类型资源返回数组、字符串类型返回字符串）则可以使用此接口。
  • ## 注意
  • 由于其他接口对树类型资源的返回参数格式是按照路径的方式返回的，所以我们提供此此接口，按照完整的树结构形式返回。
  • ## 请求示例
  • ### 获取用户授权字符串数据资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleStrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleStrResourceCode",
  • "resourceType": "STRING",
  • "strResourceAuthAction":{
  • "value": "strTestValue",
  • "actions": ["get","delete"]
  • }
  • }
  • }
  • ``` * *
  • ### 获取用户授权数据数组资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleArrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleArrResourceCode",
  • "resourceType": "ARRAY",
  • "arrResourceAuthAction":{
  • "values": ["arrTestValue1","arrTestValue2","arrTestValue3"],
  • "actions": ["get","delete"]
  • }
  • }
  • }
  • ``` * *
  • ### 获取用户授权树数据资源示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "userId": "63721xxxxxxxxxxxxdde14a3",
  • "resourceCode": "exampleArrResourceCode"
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "namespaceCode": "exampleNamespaceCode",
  • "resourceCode": "exampleArrResourceCode",
  • "resourceType": "TREE",
  • "treeResourceAuthAction":{
  • "nodeAuthActionList":[{
  • "code": "tree11",
  • "name": "tree11",
  • "value": "test11Value",
  • "actions": ["get","delete"],
  • "children": [{
  • "code": "tree111",
  • "name": "tree111",
  • "value": "test111Value",
  • "actions": ["update","read"],
  • }]
  • },{
  • "code": "tree22",
  • "name": "tree22",
  • "value": "test22Value",
  • "actions": ["get","delete"]
  • }]
  • }
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns GetUserResourceStructRespDto

func (*ManagementClient) GetUserRoles 

func (client *ManagementClient) GetUserRoles(reqDto *dto.GetUserRolesDto) *dto.RolePaginatedRespDto
  • @summary 获取用户角色列表
  • @description 通过用户 ID，获取用户角色列表，可以选择所属权限分组 code、选择指定用户 ID 类型等。
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @param namespace 所属权限分组(权限空间)的 Code
  • @returns RolePaginatedRespDto

func (*ManagementClient) GetUserSyncRelations added in v3.0.14 

func (client *ManagementClient) GetUserSyncRelations(reqDto *dto.GetUserSyncRelationsDto) *dto.SyncRelationListRespDto
  • @summary 获取用户绑定的第三方同步关系
  • @description 如果在 Authing 中的用户进行了上下游同步，此接口可以用于查询出在第三方的关联用户信息
  • @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。
  • @param userIdType 用户 ID 类型，默认值为 `user_id`，可选值为：
  • - `user_id`: Authing 用户 ID，如 `6319a1504f3xxxxf214dd5b7`
  • - `phone`: 用户手机号
  • - `email`: 用户邮箱
  • - `username`: 用户名
  • - `external_id`: 用户在外部系统的 ID，对应 Authing 用户信息的 `externalId` 字段
  • - `identity`: 用户的外部身份源信息，格式为 `<extIdpId>:<userIdInIdp>`，其中 `<extIdpId>` 为 Authing 身份源的 ID，`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`。
  • - `sync_relation`: 用户的外部身份源信息，格式为 `<provier>:<userIdInIdp>`，其中 `<provier>` 为同步身份源类型，如 wechatwork, lark；`<userIdInIdp>` 为用户在外部身份源的 ID。
  • 示例值：`lark:ou_8bae746eac07cd2564654140d2a9ac61`。 *
  • @returns SyncRelationListRespDto

func (*ManagementClient) GetUsersOfPublicAccount added in v3.0.14 

func (client *ManagementClient) GetUsersOfPublicAccount(reqDto *dto.GetUsersOfPublicAccountDto) *dto.PublicAccountPaginatedRespDto

* @summary 公共账号的用户列表 * @description 通过公共账号 ID，获取用户列表。 * @param publicAccountId 公共账号 ID * @returns PublicAccountPaginatedRespDto

func (*ManagementClient) GetVerifyConfig added in v3.0.14 

func (client *ManagementClient) GetVerifyConfig() *dto.VerifyConfigInfoRespDto

* @summary 获取 verify-config 配置 * @description 获取 verify-config 配置 * @returns VerifyConfigInfoRespDto

func (*ManagementClient) GetVerifyConfigApp added in v3.0.14 

func (client *ManagementClient) GetVerifyConfigApp(reqDto *dto.VerifyConfigAppDto) *dto.ApplicationDto

* @summary 修改 verify-config 配置 * @description 修改 verify-config 配置 * @param requestBody * @returns VerifyConfigDataDto

* @summary 获取 verify-config-app 列表 * @description 获取 verify-config-app 列表 * @param keywords 搜索关键字 * @returns ApplicationDto

func (*ManagementClient) GetWebhook 

func (client *ManagementClient) GetWebhook(reqDto *dto.GetWebhookDto) *dto.GetWebhookRespDto

* @summary 获取 Webhook 详情 * @description 根据指定的 webhookId 获取 webhook 详情 * @param webhookId Webhook ID * @returns GetWebhookRespDto

func (*ManagementClient) GetWebhookEventList 

func (client *ManagementClient) GetWebhookEventList() *dto.WebhookEventListRespDto

* @summary 获取 Webhook 事件列表 * @description 返回事件列表和分类列表 * @returns WebhookEventListRespDto

func (*ManagementClient) GetWebhookLogs 

func (client *ManagementClient) GetWebhookLogs(reqDto *dto.ListWebhookLogs) *dto.ListWebhookLogsRespDto

* @summary 获取 Webhook 日志 * @description 通过指定 webhookId，可选 page 和 limit 来获取 webhook 日志,如果 webhookId 不存在,不返回报错信息 * @param requestBody * @returns ListWebhookLogsRespDto

func (*ManagementClient) HasAnyRole 

func (client *ManagementClient) HasAnyRole(reqDto *dto.HasAnyRoleReqDto) *dto.HasAnyRoleRespDto

* @summary 判断用户是否有某个角色 * @description 通过用户 ID，判断用户是否有某个角色，支持传入多个角色，可以选择指定用户 ID 类型等。 * @param requestBody * @returns HasAnyRoleRespDto

func (*ManagementClient) Import added in v3.0.14 

func (client *ManagementClient) Import(reqDto *dto.ImportModelDto) *dto.CommonResponseDto

* @summary 导入数据 * @description 导入数据 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ImportModel added in v3.0.14 

func (client *ManagementClient) ImportModel(reqDto *dto.ImportMetadataDto) *dto.CommonResponseDto

* @summary 导入数据对象 * @description 导入数据对象 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ImportOtp 

func (client *ManagementClient) ImportOtp(reqDto *dto.ImportOtpReqDto) *dto.CommonResponseDto

* @summary 导入用户的 OTP * @description 导入用户的 OTP * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ImportTenant added in v3.0.14 

func (client *ManagementClient) ImportTenant(reqDto *dto.ImportTenantDto) *dto.ImportTenantRespDto

* @summary 导入租户 * @description 此接口用于 Excel 导入租户。 * @param requestBody * @returns ImportTenantRespDto

func (*ManagementClient) ImportTenantHistory added in v3.0.14 

func (client *ManagementClient) ImportTenantHistory(reqDto *dto.ImportTenantHistoryDto) *dto.ImportTenantHistoryRespDto

* @summary 导入租户历史 * @description 此接口用于 Excel 导入租户的历史查询。 * @param page 页码 * @param limit 每页获取的数据量 * @returns ImportTenantHistoryRespDto

func (*ManagementClient) ImportTenantNotifyUser added in v3.0.14 

func (client *ManagementClient) ImportTenantNotifyUser(reqDto *dto.ImportTenantNotifyUserDto) *dto.ImportTenantNotifyUserRespDto

* @summary 导入租户通知用户列表 * @description 此接口用于查询导入租户通知用户列表。 * @param importId 导入记录 id * @param page 页码 * @param limit 每页获取的数据量 * @returns ImportTenantNotifyUserRespDto

func (*ManagementClient) IsActionAllowed 

func (client *ManagementClient) IsActionAllowed(reqDto *dto.IsActionAllowedDto) *dto.IsActionAllowedRespDtp

* @summary 判断用户是否对某个资源的某个操作有权限 * @description 判断用户是否对某个资源的某个操作有权限。 * @param requestBody * @returns IsActionAllowedRespDtp

func (*ManagementClient) IsUserExists 

func (client *ManagementClient) IsUserExists(reqDto *dto.IsUserExistsReqDto) *dto.IsUserExistsRespDto

* @summary 判断用户是否存在 * @description 根据条件判断用户是否存在，可以筛选用户名、邮箱、手机号、第三方外部 ID 等。 * @param requestBody * @returns IsUserExistsRespDto

func (*ManagementClient) IsUserInDepartment 

func (client *ManagementClient) IsUserInDepartment(reqDto *dto.IsUserInDepartmentDto) *dto.IsUserInDepartmentRespDto

* @summary 判断用户是否在某个部门下 * @description 通过组织 code、部门 ID，判断用户是否在某个部门下，可以选择包含子部门。 * @param userId 用户唯一标志，可以是用户 ID、用户名、邮箱、手机号、外部 ID、在外部身份源的 ID。 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root`。departmentId 和 departmentCode 必传其一。 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param includeChildrenDepartments 是否包含子部门 * @param tenantId 租户 ID * @returns IsUserInDepartmentRespDto

func (*ManagementClient) KickPublicAccounts added in v3.0.14 

func (client *ManagementClient) KickPublicAccounts(reqDto *dto.KickPublicAccountsDto) *dto.IsSuccessRespDto

* @summary 强制下线公共账号 * @description 通过公共账号 ID、App ID 列表，强制让公共账号下线，可以选择指定公共账号 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) KickUsers 

func (client *ManagementClient) KickUsers(reqDto *dto.KickUsersDto) *dto.IsSuccessRespDto

* @summary 强制下线用户 * @description 通过用户 ID、App ID 列表，强制让用户下线，可以选择指定用户 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) LinkIdentity added in v3.0.14 

func (client *ManagementClient) LinkIdentity(reqDto *dto.LinkIdentityDto) *dto.LinkIdentityResDto

* @summary 给用户绑定一个身份信息 * @description 用户池管理员手动将来自外部身份源的身份信息绑定到用户上。绑定完成后，可以用执行过绑定操作的身份源登录到对应的 Authing 用户。 * @param requestBody * @returns LinkIdentityResDto

func (*ManagementClient) ListApplicationActiveUsers 

func (client *ManagementClient) ListApplicationActiveUsers(reqDto *dto.ListApplicationActiveUsersDto) *dto.UserPaginatedRespDto

* @summary 获取应用当前登录用户 * @description 获取应用当前处于登录状态的用户 * @param requestBody * @returns UserPaginatedRespDto

func (*ManagementClient) ListApplicationSimpleInfo 

func (client *ManagementClient) ListApplicationSimpleInfo(reqDto *dto.ListApplicationSimpleInfoDto) *dto.ApplicationSimpleInfoPaginatedRespDto

* @summary 获取应用简单信息列表 * @description 获取应用简单信息列表 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param isIntegrateApp 是否为集成应用 * @param isSelfBuiltApp 是否为自建应用 * @param ssoEnabled 是否开启单点登录 * @param keywords 模糊搜索字符串 * @returns ApplicationSimpleInfoPaginatedRespDto

func (*ManagementClient) ListApplications 

func (client *ManagementClient) ListApplications(reqDto *dto.ListApplicationsDto) *dto.ApplicationPaginatedRespDto

* @summary 批量删除应用授权 * @description 批量删除应用授权 * @param authIds 授权 ID * @returns IsSuccessRespDto

* @summary 获取应用列表 * @description 获取应用列表 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param isIntegrateApp 是否为集成应用 * @param isSelfBuiltApp 是否为自建应用 * @param ssoEnabled 是否开启单点登录 * @param keywords 模糊搜索字符串 * @param all 搜索应用，true：搜索所有应用, 默认为 false * @returns ApplicationPaginatedRespDto

func (*ManagementClient) ListArchivedUsers 

func (client *ManagementClient) ListArchivedUsers(reqDto *dto.ListArchivedUsersDto) *dto.ListArchivedUsersSingleRespDto

* @summary 获取已归档的用户列表 * @description 获取已归档的用户列表，支持分页，可以筛选开始时间等。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param startAt 开始时间，为精确到秒的 UNIX 时间戳，默认不指定 * @returns ListArchivedUsersSingleRespDto

func (*ManagementClient) ListAsaAccount added in v3.0.4 

func (client *ManagementClient) ListAsaAccount(reqDto *dto.ListAsaAccountsDto) *dto.AsaAccountPaginatedRespDto

* @summary 获取 ASA 账号列表 * @description 分页获取某一应用下的 ASA 账号列表 * @param appId 所属应用 ID * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns AsaAccountPaginatedRespDto

func (*ManagementClient) ListAuthApplication added in v3.0.14 

func (client *ManagementClient) ListAuthApplication(reqDto *dto.ListApplicationAuthDto) *dto.ListApplicationAuthPaginatedRespDto

* @summary 应用授权列表 * @description 应用授权列表 * @param requestBody * @returns ListApplicationAuthPaginatedRespDto

func (*ManagementClient) ListAuthSubject added in v3.0.14 

func (client *ManagementClient) ListAuthSubject(reqDto *dto.ListAuthSubjectDto) *dto.ListApplicationSubjectRespDto

* @summary 主体授权列表 * @description 主体授权列表 * @param requestBody * @returns ListApplicationSubjectRespDto

func (*ManagementClient) ListChildrenDepartments 

func (client *ManagementClient) ListChildrenDepartments(reqDto *dto.ListChildrenDepartmentsDto) *dto.DepartmentPaginatedRespDto

* @summary 获取子部门列表 * @description 通过组织 code、部门 ID，获取子部门列表，可以选择获取自定义数据、虚拟组织等。 * @param organizationCode 组织 code * @param departmentId 需要获取的部门 ID * @param status 部门的状态 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param excludeVirtualNode 是否要排除虚拟组织 * @param onlyVirtualNode 是否只包含虚拟组织 * @param withCustomData 是否获取自定义数据 * @param tenantId 租户 ID * @returns DepartmentPaginatedRespDto

func (*ManagementClient) ListCommonResource added in v3.0.4 

func (client *ManagementClient) ListCommonResource(reqDto *dto.ListCommonResourceDto) *dto.CommonResourcePaginatedRespDto

* @summary 分页获取常规资源列表 * @description 根据筛选条件，分页获取常规资源详情列表。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param keyword 查询条件 * @param namespaceCodeList 权限空间列表 * @returns CommonResourcePaginatedRespDto

func (*ManagementClient) ListCustFields added in v3.0.14 

func (client *ManagementClient) ListCustFields(reqDto *dto.ListCustomFieldsDto) *dto.ListCistomFieldsResDto
  • @summary 获取自定义字段列表
  • @description 通过主体类型，获取用户、部门或角色的自定义字段列表。
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门
  • ;该接口暂不支持分组(GROUP)
  • @param dataType 字段类型
  • @param tenantId 租户 ID
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param userVisible 用户是否可见
  • @param adminVisible 管理员是否可见
  • @param accessControl 访问控制
  • @param keyword 搜索关键词
  • @param lang 搜索语言
  • @returns ListCistomFieldsResDto

func (*ManagementClient) ListDataPolices added in v3.0.4 

func (client *ManagementClient) ListDataPolices(reqDto *dto.ListDataPoliciesDto) *dto.ListDataPoliciesPaginatedRespDto

* @summary 获取数据策略列表 * @description 分页查询数据策略列表，也可通过关键字搜索数据策略名称或者数据策略 Code 进行模糊查找。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 数据策略名称关键字搜索 * @returns ListDataPoliciesPaginatedRespDto

func (*ManagementClient) ListDataPolicyTargets added in v3.0.4 

func (client *ManagementClient) ListDataPolicyTargets(reqDto *dto.ListDataPolicyTargetsDto) *dto.ListDataPolicySubjectPaginatedRespDto

* @summary 获取数据策略下所有的授权主体的信息 * @description 获取数据策略下所有的授权主体的信息，通过授权主体类型、数据策略 ID 和数据资源 ID 查找授权主体列表。 * @param policyId 数据策略 ID * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 主体名称 * @param targetType 主体类型,包括 USER、GROUP、ROLE、ORG 四种类型 * @returns ListDataPolicySubjectPaginatedRespDto

func (*ManagementClient) ListDataResources added in v3.0.4 

func (client *ManagementClient) ListDataResources(reqDto *dto.ListDataResourcesDto) *dto.ListDataResourcesPaginatedRespDto

* @summary 获取数据资源列表 * @description 获取数据资源列表,可通过数据资源名称、数据资源 Code 和数据资源所属权限空间 Code 列表进行指定筛选。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 关键字搜索，可以是数据资源名称或者数据资源 Code * @param namespaceCodes 权限数据所属权限空间 Code 列表 * @returns ListDataResourcesPaginatedRespDto

func (*ManagementClient) ListDepartmentMemberIds 

func (client *ManagementClient) ListDepartmentMemberIds(reqDto *dto.ListDepartmentMemberIdsDto) *dto.UserIdListRespDto

* @summary 获取部门直属成员 ID 列表 * @description 通过组织 code、部门 ID，获取部门直属成员 ID 列表。 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root` * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param tenantId 租户 ID * @returns UserIdListRespDto

func (*ManagementClient) ListDepartmentMembers 

func (client *ManagementClient) ListDepartmentMembers(reqDto *dto.ListDepartmentMembersDto) *dto.UserPaginatedRespDto

* @summary 获取部门成员列表 * @description 通过组织 code、部门 ID、排序，获取部门成员列表，支持分页，可以选择获取自定义数据、identities 等。 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root` * @param sortBy 排序依据 * @param orderBy 增序还是倒序 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param includeChildrenDepartments 是否包含子部门的成员 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withCustomData 是否获取自定义数据 * @param withIdentities 是否获取 identities * @param withDepartmentIds 是否获取部门 ID 列表 * @param tenantId 租户 ID * @returns UserPaginatedRespDto

func (*ManagementClient) ListEventApps added in v3.0.14 

func (client *ManagementClient) ListEventApps() *dto.EventAppPaginatedRespDto

* @summary 获取事件应用列表 * @description 获取事件应用列表 * @returns EventAppPaginatedRespDto

func (*ManagementClient) ListEvents added in v3.0.14 

func (client *ManagementClient) ListEvents(reqDto *dto.ListEventsDto) *dto.OpenEventPaginatedRespDto

* @summary 获取事件列表 * @description 获取 Authing 服务支持的所有事件列表 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param app 应用类型 * @returns OpenEventPaginatedRespDto

func (*ManagementClient) ListExtIdp 

func (client *ManagementClient) ListExtIdp(reqDto *dto.ListExtIdpDto) *dto.ExtIdpListPaginatedRespDto

* @summary 获取身份源列表 * @description 获取身份源列表，可以指定 租户 ID 筛选。 * @param tenantId 租户 ID * @param appId 应用 ID * @returns ExtIdpListPaginatedRespDto

func (*ManagementClient) ListField added in v3.0.14 

func (client *ManagementClient) ListField(reqDto *dto.ListFieldDto) *dto.FunctionFieldListResDto

* @summary 获取数据对象字段列表 * @description 获取数据对象字段列表 * @param modelId 功能 id * @returns FunctionFieldListResDto

func (*ManagementClient) ListGroupMembers 

func (client *ManagementClient) ListGroupMembers(reqDto *dto.ListGroupMembersDto) *dto.UserPaginatedRespDto

* @summary 获取分组成员列表 * @description 通过分组 code，获取分组成员列表，支持分页，可以获取自定义数据、identities、部门 ID 列表。 * @param code 分组 code * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withCustomData 是否获取自定义数据 * @param withIdentities 是否获取 identities * @param withDepartmentIds 是否获取部门 ID 列表 * @returns UserPaginatedRespDto

func (*ManagementClient) ListGroups 

func (client *ManagementClient) ListGroups(reqDto *dto.ListGroupsDto) *dto.GroupPaginatedRespDto

* @summary 获取分组列表 * @description 获取分组列表，支持分页。 * @param keywords 搜索分组 code 或分组名称 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withMetadata 是否展示元数据内容 * @param withCustomData 是否获取自定义数据 * @param flatCustomData 是否拍平扩展字段 * @returns GroupPaginatedRespDto

func (*ManagementClient) ListInviteTennatUserRecords added in v3.0.14 

func (client *ManagementClient) ListInviteTennatUserRecords(reqDto *dto.ListInviteTenantUserRecordsDto) *dto.InviteTenantUserRecordListRespDto

* @summary 获取可访问的租户控制台列表 * @description 根据用户 ID 获取可访问的租户控制台列表 * @param keywords 搜索关键字 * @param page 页码 * @param limit 每页获取的数据量 * @returns InviteTenantUserRecordListRespDto

func (*ManagementClient) ListModel added in v3.0.14 

func (client *ManagementClient) ListModel() *dto.FunctionModelListDto

* @summary 获取数据对象列表 * @description 获取数据对象列表 * @returns FunctionModelListDto

func (*ManagementClient) ListMultipleTenantAdmin added in v3.0.14 

func (client *ManagementClient) ListMultipleTenantAdmin(reqDto *dto.ListMultipleTenantAdminsDto) *dto.MultipleTenantAdminPaginatedRespDto

* @summary 获取多租户管理员用户列表 * @description 根据用户池 ID 获取某个用户池内拥有多租户管理权限的用户列表 * @param keywords 搜索关键字 * @param page 页码 * @param limit 每页获取的数据量 * @returns MultipleTenantAdminPaginatedRespDto

func (*ManagementClient) ListNamespaceRoles added in v3.0.4 

func (client *ManagementClient) ListNamespaceRoles(reqDto *dto.ListNamespaceRolesDto) *dto.NamespaceRolesListPaginatedRespDto

* @summary 分页权限分组下所有的角色列表 * @description 根据筛选条件，分页获取权限分组下所有的角色列表。 * @param code 权限分组唯一标志符 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param keywords 角色 Code 或者名称 * @returns NamespaceRolesListPaginatedRespDto

func (*ManagementClient) ListNamespaces added in v3.0.4 

func (client *ManagementClient) ListNamespaces(reqDto *dto.ListNamespacesDto) *dto.NamespaceListPaginatedRespDto

* @summary 分页获取权限分组列表 * @description 根据筛选条件，分页获取权限分组列表。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param keywords 搜索权限分组 Code * @returns NamespaceListPaginatedRespDto

func (*ManagementClient) ListOperate added in v3.0.14 

func (client *ManagementClient) ListOperate(reqDto *dto.ListOperateDto) *dto.OperateModelDto

* @summary 操作管理列表(分页) * @description 操作管理列表(分页) * @param modelId model Id * @param keywords 搜索功能名称 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns OperateModelDto

func (*ManagementClient) ListOperateAll added in v3.0.14 

func (client *ManagementClient) ListOperateAll(reqDto *dto.AllOperateDto) *dto.OperateModelDto

* @summary 全部操作管理列表 * @description 全部操作管理列表 * @param modelId model Id * @returns OperateModelDto

func (*ManagementClient) ListOrganizations 

func (client *ManagementClient) ListOrganizations(reqDto *dto.ListOrganizationsDto) *dto.OrganizationPaginatedRespDto

* @summary 获取组织机构列表 * @description 获取组织机构列表，支持分页。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param fetchAll 拉取所有 * @param withCustomData 是否获取自定义数据 * @param withPost 是否获取 部门信息 * @param tenantId 租户 ID * @param status 组织的状态 * @returns OrganizationPaginatedRespDto

func (*ManagementClient) ListPermissionNamespaceRoles added in v3.0.4 

func (client *ManagementClient) ListPermissionNamespaceRoles(reqDto *dto.ListPermissionNamespaceRolesDto) *dto.PermissionNamespaceRolesListPaginatedRespDto

* @summary 分页查询权限空间下所有的角色列表 * @description 分页查询权限空间下所有的角色列表，分页获取权限空间下所有的角色列表。 * @param code 权限分组唯一标志符 Code * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 角色 Code 或者名称 * @returns PermissionNamespaceRolesListPaginatedRespDto

func (*ManagementClient) ListPermissionNamespaces added in v3.0.4 

func (client *ManagementClient) ListPermissionNamespaces(reqDto *dto.ListPermissionNamespacesDto) *dto.PermissionNamespaceListPaginatedRespDto

* @summary 分页获取权限空间列表 * @description 分页获取权限空间列表。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 权限空间 name * @returns PermissionNamespaceListPaginatedRespDto

func (*ManagementClient) ListPermissionView added in v3.0.14 

func (client *ManagementClient) ListPermissionView(reqDto *dto.ListPermissionViewDto) *dto.ListPermissionViewResponseDto
  • @summary 获取权限视图数据列表
  • @description
  • ## 描述
  • 此接口用于导出菜单：权限管理 -> 数据权限 -> 权限试图列表数据，如果你需要拉取我们数据权限的授权数据（所有用户拥有的所有资源的所有权限），则可以使用此接口。 *
  • @param requestBody
  • @returns ListPermissionViewResponseDto

func (*ManagementClient) ListPipelineFunctions 

func (client *ManagementClient) ListPipelineFunctions(reqDto *dto.ListPipelineFunctionsDto) *dto.PipelineFunctionPaginatedRespDto
  • @summary 获取 Pipeline 函数列表
  • @description 获取 Pipeline 函数列表
  • @param scene 通过函数的触发场景进行筛选（可选，默认返回所有）：
  • - `PRE_REGISTER`: 注册前
  • - `POST_REGISTER`: 注册后
  • - `PRE_AUTHENTICATION`: 认证前
  • - `POST_AUTHENTICATION`: 认证后
  • - `PRE_OIDC_ID_TOKEN_ISSUED`: OIDC ID Token 签发前
  • - `PRE_OIDC_ACCESS_TOKEN_ISSUED`: OIDC Access Token 签发前
  • - `PRE_COMPLETE_USER_INFO`: 补全用户信息前 *
  • @returns PipelineFunctionPaginatedRespDto

func (*ManagementClient) ListPublicAccounts added in v3.0.14 

func (client *ManagementClient) ListPublicAccounts(reqDto *dto.ListPublicAccountsRequestDto) *dto.PublicAccountPaginatedRespDto
  • @summary 获取/搜索公共账号列表
  • @description
  • 此接口用于获取用户列表，支持模糊搜索，以及通过用户基础字段、用户自定义字段、用户所在部门、用户历史登录应用等维度筛选用户。 *
  • ### 模糊搜素示例 *
  • 模糊搜索默认会从 `phone`, `email`, `name`, `username`, `nickname` 五个字段对用户进行模糊搜索，你也可以通过设置 `options.fuzzySearchOn`
  • 决定模糊匹配的字段范围： *
  • ```json
  • {
  • "keywords": "北京",
  • "options": {
  • "fuzzySearchOn": [
  • "address"
  • ]
  • }
  • }
  • ``` *
  • ### 高级搜索示例 *
  • 你可以通过 `advancedFilter` 进行高级搜索，高级搜索支持通过用户的基础信息、自定义数据、所在部门、用户来源、登录应用、外部身份源信息等维度对用户进行筛选。
  • **且这些筛选条件可以任意组合。** *
  • #### 筛选状态为禁用的用户 *
  • 用户状态（`status`）为字符串类型，可选值为 `Activated` 和 `Suspended`： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "status",
  • "operator": "EQUAL",
  • "value": "Suspended"
  • }
  • ]
  • }
  • ``` *
  • #### 筛选邮箱中包含 `@example.com` 的用户 *
  • 用户邮箱（`email`）为字符串类型，可以进行模糊搜索： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "email",
  • "operator": "CONTAINS",
  • "value": "@example.com"
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户的任意扩展字段进行搜索 *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "some-custom-key",
  • "operator": "EQUAL",
  • "value": "some-value"
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户登录次数筛选 *
  • 筛选登录次数大于 10 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "GREATER",
  • "value": 10
  • }
  • ]
  • }
  • ``` *
  • 筛选登录次数在 10 - 100 次的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "BETWEEN",
  • "value": [10, 100]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户上次登录时间进行筛选 *
  • 筛选最近 7 天内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLoginTime",
  • "operator": "GREATER",
  • "value": new Date(Date.now() - 7 * 24 * 60 * 60 * 1000)
  • }
  • ]
  • }
  • ``` *
  • 筛选在某一段时间内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLogin",
  • "operator": "BETWEEN",
  • "value": [
  • Date.now() - 14 * 24 * 60 * 60 * 1000,
  • Date.now() - 7 * 24 * 60 * 60 * 1000
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户曾经登录过的应用筛选 *
  • 筛选出曾经登录过应用 `appId1` 或者 `appId2` 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loggedInApps",
  • "operator": "IN",
  • "value": [
  • "appId1",
  • "appId2"
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户所在部门进行筛选 *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "department",
  • "operator": "IN",
  • "value": [
  • {
  • "organizationCode": "steamory",
  • "departmentId": "root",
  • "departmentIdType": "department_id",
  • "includeChildrenDepartments": true
  • }
  • ]
  • }
  • ]
  • }
  • ``` * *
  • @param requestBody
  • @returns PublicAccountPaginatedRespDto

func (*ManagementClient) ListResourceTargets added in v3.0.4 

func (client *ManagementClient) ListResourceTargets(reqDto *dto.ListResourceTargetsDto) *dto.ListResourceTargetsRespDto
  • @summary 获取资源被授权的用户列表
  • @description
  • ## 描述
  • 当你需要获取拥有指定资源的权限的用户时，可以使用此接口。
  • ## 场景举例
  • 假如你的业务场景是：想看看当前文档能够编辑的用户列表，那么你可以使用此接口。
  • ## 请求示例
  • ### 获取字符串和数组资源被授权的用户列表示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["get", "update", "read"],
  • "resources":["strResourceCode1", "arrayResourceCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "authUserList": [{
  • "resource": "strResourceCode1",
  • "actionAuthList": [{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "get"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "update"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "read"
  • }]
  • },{
  • "resource": "arrayResourceCode1",
  • "actionAuthList": [{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "get"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "update"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "read"
  • }]
  • }]
  • }
  • }
  • ``` *
  • ### 获取树资源被授权的用户列表示例 *
  • - 入参 *
  • ```json
  • {
  • "namespaceCode": "examplePermissionNamespace",
  • "actions": ["get", "update", "delete"],
  • "resources":["treeResourceCode1/StructCode1/resourceStructChildrenCode1", "treeResourceCode2/StructCode1/resourceStructChildrenCode1"]
  • }
  • ``` *
  • - 出参 *
  • ```json
  • {
  • "statusCode": 200,
  • "message": "操作成功",
  • "apiCode": 20001,
  • "data":{
  • "authUserList": [{
  • "resource": "treeResourceCode1/StructCode1/resourceStructChildrenCode1",
  • "actionAuthList": [{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "get"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "update"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "delete"
  • }]
  • },{
  • "resource": "treeResourceCode2/StructCode1/resourceStructChildrenCode1",
  • "actionAuthList": [{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "get"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "update"
  • },{
  • "userIds": ["63721xxxxxxxxxxxxdde14a3"],
  • "action": "delete"
  • }]
  • }]
  • }
  • }
  • ``` *
  • @param requestBody
  • @returns ListResourceTargetsRespDto

func (*ManagementClient) ListResources 

func (client *ManagementClient) ListResources(reqDto *dto.ListResourcesDto) *dto.ResourcePaginatedRespDto

* @summary 分页获取资源列表 * @description 根据筛选条件，分页获取资源详情列表。 * @param namespace 所属权限分组(权限空间)的 Code * @param type 资源类型 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns ResourcePaginatedRespDto

func (*ManagementClient) ListRoleAssignments added in v3.0.5 

func (client *ManagementClient) ListRoleAssignments(reqDto *dto.ListRoleAssignmentsDto) *dto.RoleListPageRespDto

* @summary 获取角色授权列表 * @description 获取角色授权列表。 * @param roleCode 角色 code,只能使用字母、数字和 -_，最多 50 字符 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 按角色 Code 或者角色名称查询 * @param namespaceCode 权限空间code * @param targetType 目标类型，接受用户，部门 * @returns RoleListPageRespDto

func (*ManagementClient) ListRoleDepartments 

func (client *ManagementClient) ListRoleDepartments(reqDto *dto.ListRoleDepartmentsDto) *dto.RoleDepartmentListPaginatedRespDto

* @summary 获取角色的部门列表 * @description 通过权限分组内角色 code，获取角色的部门列表，支持分页。 * @param code 权限分组内角色的唯一标识符 * @param namespace 所属权限分组的 code * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns RoleDepartmentListPaginatedRespDto

func (*ManagementClient) ListRoleMembers 

func (client *ManagementClient) ListRoleMembers(reqDto *dto.ListRoleMembersDto) *dto.UserPaginatedRespDto

* @summary 获取角色成员列表 * @description 通过权限分组内内角色 code，获取角色成员列表，支持分页，可以选择或获取自定义数据、identities 等。 * @param code 权限分组内角色的唯一标识符 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withCustomData 是否获取自定义数据 * @param withIdentities 是否获取 identities * @param withDepartmentIds 是否获取部门 ID 列表 * @param namespace 所属权限分组的 code * @returns UserPaginatedRespDto

func (*ManagementClient) ListRoles 

func (client *ManagementClient) ListRoles(reqDto *dto.ListRolesDto) *dto.RolePaginatedRespDto

* @summary 获取角色列表 * @description 获取角色列表，支持分页、支持根据权限分组（权限空间）筛选 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param keywords 用于根据角色的 code 或者名称进行模糊搜索，可选。 * @param namespace 所属权限分组(权限空间)的 code * @returns RolePaginatedRespDto

func (*ManagementClient) ListRow added in v3.0.14 

func (client *ManagementClient) ListRow(reqDto *dto.FilterDto) *dto.FunctionModelValueListResDto

* @summary 数据对象高级搜索 * @description 数据对象高级搜索 * @param requestBody * @returns FunctionModelValueListResDto

func (*ManagementClient) ListSimpleDataPolices added in v3.0.4 

func (client *ManagementClient) ListSimpleDataPolices(reqDto *dto.ListSimpleDataPoliciesDto) *dto.ListSimpleDataPoliciesPaginatedRespDto

* @summary 获取数据策略简略信息列表 * @description 分页获取数据策略简略信息列表，通过关键字搜索数据策略名称或者数据策略 Code 进行模糊查找出数据策略 ID、数据策略名称和数据策略描述信息。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param query 数据策略名称关键字搜索 * @returns ListSimpleDataPoliciesPaginatedRespDto

func (*ManagementClient) ListSyncJobLogs 

func (client *ManagementClient) ListSyncJobLogs(reqDto *dto.ListSyncJobLogsDto) *dto.TriggerSyncTaskRespDto
  • @summary 获取同步作业详情
  • @description 获取同步作业详情
  • @param syncJobId 同步作业 ID
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param success 根据是否操作成功进行筛选
  • @param action 根据操作类型进行筛选：
  • - `CreateUser`: 创建用户
  • - `UpdateUser`: 修改用户信息
  • - `DeleteUser`: 删除用户
  • - `UpdateUserIdentifier`: 修改用户唯一标志符
  • - `ChangeUserDepartment`: 修改用户部门
  • - `CreateDepartment`: 创建部门
  • - `UpdateDepartment`: 修改部门信息
  • - `DeleteDepartment`: 删除部门
  • - `MoveDepartment`: 移动部门
  • - `UpdateDepartmentLeader`: 同步部门负责人
  • - `CreateGroup`: 创建分组
  • - `UpdateGroup`: 修改分组
  • - `DeleteGroup`: 删除分组
  • - `Updateless`: 无更新 *
  • @param objectType 操作对象类型:
  • - `department`: 部门
  • - `user`: 用户 *
  • @returns TriggerSyncTaskRespDto

func (*ManagementClient) ListSyncJobs 

func (client *ManagementClient) ListSyncJobs(reqDto *dto.ListSyncJobsDto) *dto.SyncJobPaginatedRespDto
  • @summary 获取同步作业详情
  • @description 获取同步作业详情
  • @param syncTaskId 同步任务 ID
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param syncTrigger 同步任务触发类型：
  • - `manually`: 手动触发执行
  • - `timed`: 定时触发
  • - `automatic`: 根据事件自动触发 *
  • @returns SyncJobPaginatedRespDto

func (*ManagementClient) ListSyncRiskOperations 

func (client *ManagementClient) ListSyncRiskOperations(reqDto *dto.ListSyncRiskOperationsDto) *dto.SyncRiskOperationPaginatedRespDto
  • @summary 获取同步风险操作列表
  • @description 获取同步风险操作列表
  • @param syncTaskId 同步任务 ID
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param status 根据执行状态筛选
  • @param objectType 根据操作对象类型，默认获取所有类型的记录：
  • - `department`: 部门
  • - `user`: 用户 *
  • @returns SyncRiskOperationPaginatedRespDto

func (*ManagementClient) ListSyncTasks 

func (client *ManagementClient) ListSyncTasks(reqDto *dto.ListSyncTasksDto) *dto.SyncTaskPaginatedRespDto

* @summary 获取同步任务列表 * @description 获取同步任务列表 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns SyncTaskPaginatedRespDto

func (*ManagementClient) ListTenantAdmin added in v3.0.14 

func (client *ManagementClient) ListTenantAdmin(reqDto *dto.ListTenantAdminDto) *dto.TenantUserListPaginatedRespDto

* @summary 获取租户管理员列表 * @description 此接口用于获取租户成员列表，支持模糊搜索。 * @param requestBody * @returns TenantUserListPaginatedRespDto

func (*ManagementClient) ListTenantApplications added in v3.0.7 

func (client *ManagementClient) ListTenantApplications(reqDto *dto.ListTenantApplicationsDto) *dto.TenantApplicationListPaginatedRespDto

* @summary 获取租户应用列表 * @description 获取应用列表，可以指定 租户 ID 筛选。 * @param page 获取应用列表的页码 * @param limit 每页获取的应用数量 * @param keywords 搜索关键字 * @param ssoEnabled 应用是否加入单点登录 * @returns TenantApplicationListPaginatedRespDto

func (*ManagementClient) ListTenantCooperators added in v3.0.14 

func (client *ManagementClient) ListTenantCooperators(reqDto *dto.ListTenantCooperatorsDto) *dto.TenantCooperatorPaginatedRespDto

* @summary 获取协作管理员用户列表 * @description 根据用户池 ID 获取某个用户池内拥有协作管理员能力的用户列表 * @param keywords 搜索关键字 * @param external 是否外部 * @param page 页码 * @param limit 每页获取的数据量 * @returns TenantCooperatorPaginatedRespDto

func (*ManagementClient) ListTenantExtIdp 

func (client *ManagementClient) ListTenantExtIdp(reqDto *dto.ListTenantExtIdpDto) *dto.ExtIdpListPaginatedRespDto

* @summary 租户控制台获取身份源列表 * @description 在租户控制台内获取身份源列表，可以根据 应用 ID 筛选。 * @param tenantId 租户 ID * @param appId 应用 ID * @param type 身份源类型 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns ExtIdpListPaginatedRespDto

func (*ManagementClient) ListTenantUsers added in v3.0.14 

func (client *ManagementClient) ListTenantUsers(reqDto *dto.ListTenantUserDto) *dto.TenantUserListPaginatedRespDto
  • @summary 获取/搜索租户成员列表
  • @description
  • 此接口用于获取用户列表，支持模糊搜索，以及通过用户基础字段、用户自定义字段、用户所在部门、用户历史登录应用等维度筛选用户。 *
  • ### 模糊搜素示例 *
  • 模糊搜索默认会从 `phone`, `email`, `name`, `username`, `nickname` 五个字段对用户进行模糊搜索，你也可以通过设置 `options.fuzzySearchOn`
  • 决定模糊匹配的字段范围： *
  • ```json
  • {
  • "keywords": "北京",
  • "options": {
  • "fuzzySearchOn": [
  • "address"
  • ]
  • }
  • }
  • ``` *
  • ### 高级搜索示例 *
  • 你可以通过 `advancedFilter` 进行高级搜索，高级搜索支持通过用户的基础信息、自定义数据、所在部门、用户来源、登录应用、外部身份源信息等维度对用户进行筛选。
  • **且这些筛选条件可以任意组合。** *
  • #### 筛选邮箱中包含 `@example.com` 的用户 *
  • 用户邮箱（`email`）为字符串类型，可以进行模糊搜索： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "email",
  • "operator": "CONTAINS",
  • "value": "@example.com"
  • }
  • ]
  • }
  • ``` * *
  • #### 根据用户登录次数筛选 *
  • 筛选登录次数大于 10 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "GREATER",
  • "value": 10
  • }
  • ]
  • }
  • ``` *
  • 筛选登录次数在 10 - 100 次的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "BETWEEN",
  • "value": [10, 100]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户上次登录时间进行筛选 *
  • 筛选最近 7 天内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLoginTime",
  • "operator": "GREATER",
  • "value": new Date(Date.now() - 7 * 24 * 60 * 60 * 1000)
  • }
  • ]
  • }
  • ``` *
  • 筛选在某一段时间内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLoginTime",
  • "operator": "BETWEEN",
  • "value": [
  • Date.now() - 14 * 24 * 60 * 60 * 1000,
  • Date.now() - 7 * 24 * 60 * 60 * 1000
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户曾经登录过的应用筛选 *
  • 筛选出曾经登录过应用 `appId1` 或者 `appId2` 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loggedInApps",
  • "operator": "IN",
  • "value": [
  • "appId1",
  • "appId2"
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户所在部门进行筛选 *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "department",
  • "operator": "IN",
  • "value": [
  • {
  • "organizationCode": "steamory",
  • "departmentId": "root",
  • "departmentIdType": "department_id",
  • "includeChildrenDepartments": true
  • }
  • ]
  • }
  • ]
  • }
  • ``` * *
  • @param requestBody
  • @returns TenantUserListPaginatedRespDto

func (*ManagementClient) ListTenants added in v3.0.14 

func (client *ManagementClient) ListTenants(reqDto *dto.ListTenantsDto) *dto.TenantListPaginatedRespDto

* @summary 获取/搜索租户列表 * @description 此接口用于获取租户列表，支持模糊搜索。 * @param keywords 搜索关键字 * @param withMembersCount 是否增加返回租户成员统计 * @param withAppDetail 增加返回租户下 app 简单信息 * @param withCreatorDetail 增加返回租户下创建者简单信息 * @param withSourceAppDetail 增加返回租户下来源 app 简单信息 * @param page 页码 * @param limit 每页获取的数据量 * @param source 租户来源 * @returns TenantListPaginatedRespDto

func (*ManagementClient) ListUserBaseFields added in v3.0.14 

func (client *ManagementClient) ListUserBaseFields(reqDto *dto.ListUserBaseFieldsDto) *dto.ListCistomFieldsResDto
  • @summary 获取用户内置字段列表
  • @description 获取用户内置的字段列表
  • @param targetType 目标对象类型：
  • - `USER`: 用户
  • - `ROLE`: 角色
  • - `GROUP`: 分组
  • - `DEPARTMENT`: 部门
  • ;该接口暂不支持分组(GROUP)
  • @param dataType 字段类型
  • @param tenantId 租户 ID
  • @param page 当前页数，从 1 开始
  • @param limit 每页数目，最大不能超过 50，默认为 10
  • @param userVisible 用户是否可见
  • @param adminVisible 管理员是否可见
  • @param accessControl 访问控制
  • @param keyword 搜索关键词
  • @param lang 搜索语言
  • @returns ListCistomFieldsResDto

func (*ManagementClient) ListUsers 

func (client *ManagementClient) ListUsers(reqDto *dto.ListUsersRequestDto) *dto.UserPaginatedRespDto
  • @summary 获取/搜索用户列表
  • @description
  • 此接口用于获取用户列表，支持模糊搜索，以及通过用户基础字段、用户自定义字段、用户所在部门、用户历史登录应用等维度筛选用户。 *
  • ### 模糊搜素示例 *
  • 模糊搜索默认会从 `phone`, `email`, `name`, `username`, `nickname` 五个字段对用户进行模糊搜索，你也可以通过设置 `options.fuzzySearchOn`
  • 决定模糊匹配的字段范围： *
  • ```json
  • {
  • "keywords": "北京",
  • "options": {
  • "fuzzySearchOn": [
  • "address"
  • ]
  • }
  • }
  • ``` *
  • ### 高级搜索示例 *
  • 你可以通过 `advancedFilter` 进行高级搜索，高级搜索支持通过用户的基础信息、自定义数据、所在部门、用户来源、登录应用、外部身份源信息等维度对用户进行筛选。
  • **且这些筛选条件可以任意组合。** *
  • #### 筛选状态为禁用的用户 *
  • 用户状态（`status`）为字符串类型，可选值为 `Activated` 和 `Suspended`： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "status",
  • "operator": "EQUAL",
  • "value": "Suspended"
  • }
  • ]
  • }
  • ``` *
  • #### 筛选邮箱中包含 `@example.com` 的用户 *
  • 用户邮箱（`email`）为字符串类型，可以进行模糊搜索： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "email",
  • "operator": "CONTAINS",
  • "value": "@example.com"
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户的任意扩展字段进行搜索 *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "some-custom-key",
  • "operator": "EQUAL",
  • "value": "some-value"
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户登录次数筛选 *
  • 筛选登录次数大于 10 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "GREATER",
  • "value": 10
  • }
  • ]
  • }
  • ``` *
  • 筛选登录次数在 10 - 100 次的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loginsCount",
  • "operator": "BETWEEN",
  • "value": [10, 100]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户上次登录时间进行筛选 *
  • 筛选最近 7 天内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLoginTime",
  • "operator": "GREATER",
  • "value": new Date(Date.now() - 7 * 24 * 60 * 60 * 1000)
  • }
  • ]
  • }
  • ``` *
  • 筛选在某一段时间内登录过的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "lastLogin",
  • "operator": "BETWEEN",
  • "value": [
  • Date.now() - 14 * 24 * 60 * 60 * 1000,
  • Date.now() - 7 * 24 * 60 * 60 * 1000
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户曾经登录过的应用筛选 *
  • 筛选出曾经登录过应用 `appId1` 或者 `appId2` 的用户： *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "loggedInApps",
  • "operator": "IN",
  • "value": [
  • "appId1",
  • "appId2"
  • ]
  • }
  • ]
  • }
  • ``` *
  • #### 根据用户所在部门进行筛选 *
  • ```json
  • {
  • "advancedFilter": [
  • {
  • "field": "department",
  • "operator": "IN",
  • "value": [
  • {
  • "organizationCode": "steamory",
  • "departmentId": "root",
  • "departmentIdType": "department_id",
  • "includeChildrenDepartments": true
  • }
  • ]
  • }
  • ]
  • }
  • ``` * *
  • @param requestBody
  • @returns UserPaginatedRespDto

func (*ManagementClient) ListUsersLegacy 

func (client *ManagementClient) ListUsersLegacy(reqDto *dto.ListUsersDto) *dto.UserPaginatedRespDto

* @deprecated * @summary 获取用户列表 * @description 获取用户列表接口，支持分页，可以选择获取自定义数据、identities 等。 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param status 账户当前状态，如 已停用、已离职、正常状态、已归档 * @param updatedAtStart 用户创建、修改开始时间，为精确到秒的 UNIX 时间戳；支持获取从某一段时间之后的增量数据 * @param updatedAtEnd 用户创建、修改终止时间，为精确到秒的 UNIX 时间戳；支持获取某一段时间内的增量数据。默认为当前时间 * @param withCustomData 是否获取自定义数据 * @param withPost 是否获取 部门信息 * @param withIdentities 是否获取 identities * @param withDepartmentIds 是否获取部门 ID 列表 * @returns UserPaginatedRespDto

func (*ManagementClient) ListWebhooks 

func (client *ManagementClient) ListWebhooks(reqDto *dto.ListWebhooksDto) *dto.GetWebhooksRespDto

* @summary 获取 Webhook 列表 * @description 获取 Webhook 列表，可选页数、分页大小来获取 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns GetWebhooksRespDto

func (*ManagementClient) ListWhitelists added in v3.0.14 

func (client *ManagementClient) ListWhitelists(reqDto *dto.ListWhitelistDto) *dto.WhitelistListRespDto

* @summary 获取注册白名单列表 * @description 获取注册白名单列表，可选页数、分页大小来获取 * @param type 白名单类型 * @returns WhitelistListRespDto

func (*ManagementClient) PostList added in v3.0.14 

func (client *ManagementClient) PostList(reqDto *dto.ListPostDto) *dto.PostPaginatedRespDto

* @summary 岗位列表 * @description 岗位列表 * @param keywords 搜索岗位 code 或名称 * @param skipCount 是否统计岗位关联的部门数和用户数 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withMetadata 是否展示元数据内容 * @param withCustomData 是否获取自定义数据 * @param flatCustomData 是否拍平扩展字段 * @returns PostPaginatedRespDto

func (*ManagementClient) PreviewEmailTemplate 

func (client *ManagementClient) PreviewEmailTemplate(reqDto *dto.PreviewEmailTemplateDto) *dto.PreviewEmailTemplateRespDto

* @summary 预览邮件模版 * @description 预览邮件模版 * @param requestBody * @returns PreviewEmailTemplateRespDto

func (*ManagementClient) PubEvent added in v3.0.10 

func (client *ManagementClient) PubEvent(eventCode string, data interface{}) *dto.IsSuccessRespDto

* @summary 事件发布 * @description 根据事件编码发布一个自定义事件 * @param eventCode 事件编码 * @param body 事件消息 * @returns IsSuccessRespDto

func (*ManagementClient) PubUserEvent added in v3.0.14 

func (client *ManagementClient) PubUserEvent(reqDto *dto.PubEventDto) *dto.PubEventRespDto

* @summary 认证端推送自定义事件 * @description 认证端向 Authing 事件中心推送自定义事件 * @param requestBody * @returns PubEventRespDto

func (*ManagementClient) QueryLdapConfigInfo added in v3.0.14 

func (client *ManagementClient) QueryLdapConfigInfo() *dto.LdapConfigInfoRespDto

* @summary 获取 LDAP server 配置信息 * @description 获取 LDAP server 配置信息 * @returns LdapConfigInfoRespDto

func (*ManagementClient) QueryLdapLog added in v3.0.14 

func (client *ManagementClient) QueryLdapLog(reqDto *dto.GetLdapServerLogDto) *dto.LdapLogRespDto

* @summary LDAP server 日志查询 * @description LDAP server 日志查询 * @param type 类型：1 访问日志，2 错误日志 * @param page 当前页,从 1 开始 * @param limit 每页条数 * @param connection 连接标识 * @param operationNumber 操作码 * @param errorCode 错误码 * @param message 消息内容 * @param startTime 开始时间-时间戳 * @param endTime 结束时间-时间戳 * @returns LdapLogRespDto

func (*ManagementClient) QueryLdapSubEntries added in v3.0.14 

func (client *ManagementClient) QueryLdapSubEntries(reqDto *dto.GetLdapSubEntriesDto) *dto.LdapLogRespDto

* @summary LDAP server 根据 DN 查询下一级 * @description LDAP server 根据 DN 查询下一级 * @param page 当前页,从 1 开始 * @param limit 每页条数 * @param dn 当前 DN * @returns LdapLogRespDto

func (*ManagementClient) RefreshApplicationSecret 

func (client *ManagementClient) RefreshApplicationSecret(reqDto *dto.RefreshApplicationSecretDto) *dto.RefreshApplicationSecretRespDto

* @summary 刷新应用密钥 * @description 刷新应用密钥 * @param requestBody * @returns RefreshApplicationSecretRespDto

func (*ManagementClient) RemoteField added in v3.0.14 

func (client *ManagementClient) RemoteField(reqDto *dto.FunctionModelFieldIdDto) *dto.CommonResponseDto

* @summary 删除数据对象的字段 * @description 根据功能字段 id 、功能 id 、字段属性名删除对应的字段 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemoveDepartmentMembers 

func (client *ManagementClient) RemoveDepartmentMembers(reqDto *dto.RemoveDepartmentMembersReqDto) *dto.IsSuccessRespDto

* @summary 部门下删除成员 * @description 通过部门 ID、组织 code，删除部门下成员。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) RemoveGroupMembers 

func (client *ManagementClient) RemoveGroupMembers(reqDto *dto.RemoveGroupMembersReqDto) *dto.IsSuccessRespDto

* @summary 批量移除分组成员 * @description 批量移除分组成员，成员以用户 ID 数组形式传递。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) RemoveModel added in v3.0.14 

func (client *ManagementClient) RemoveModel(reqDto *dto.FunctionModelIdDto) *dto.CommonResponseDto

* @summary 删除数据对象 * @description 根据请求的功能 id ，删除对应的数据对象 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemoveOperate added in v3.0.14 

func (client *ManagementClient) RemoveOperate(reqDto *dto.FunctionModelOperateIdDto) *dto.CommonResponseDto

* @summary 移除自定义操作 * @description 移除自定义操作 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemovePost added in v3.0.14 

func (client *ManagementClient) RemovePost(reqDto *dto.RemovePostDto) *dto.CommonResponseDto

* @summary 删除岗位 * @description 删除岗位 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemoveRelationValue added in v3.0.14 

func (client *ManagementClient) RemoveRelationValue(reqDto *dto.RemoveRelationValueDto) *dto.CommonResponseDto

* @summary 删除行关联数据 * @description 删除行关联数据 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemoveRow added in v3.0.14 

func (client *ManagementClient) RemoveRow(reqDto *dto.RemoveRowDto) *dto.CommonResponseDto

* @summary 删除行 * @description 删除行 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RemoveTenantDepartmentMembers added in v3.0.14 

func (client *ManagementClient) RemoveTenantDepartmentMembers(reqDto *dto.RemoveTenantDepartmentMembersReqDto) *dto.IsSuccessRespDto

* @summary 租户部门下删除成员 * @description 通过部门 ID、组织 code，删除部门下成员。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) RemoveTenantUsers added in v3.0.14 

func (client *ManagementClient) RemoveTenantUsers(reqDto *dto.RemoveTenantUsersDto) *dto.CommonResponseDto

* @summary 批量移除租户成员 * @description 此接口用于根据用户 ID 或租户成员 ID 批量移除租户成员。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) ResetUserPrincipalAuthenticationInfo 

func (client *ManagementClient) ResetUserPrincipalAuthenticationInfo(reqDto *dto.ResetUserPrincipalAuthenticationInfoDto) *dto.IsSuccessRespDto

* @summary 删除用户实名认证信息 * @description 通过用户 ID，删除用户实名认证信息，可以选择指定用户 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) ResignPublicAccountBatch added in v3.0.14 

func (client *ManagementClient) ResignPublicAccountBatch(reqDto *dto.ResignUserBatchReqDto) *dto.ResignUserRespDto
  • @summary 批量离职用户
  • @description 批量离职用户。离职操作会进行以下操作： *
  • - 离职后该成员授权、部门、角色、分组、岗位关系将被删除；
  • - 离职后将保留用户基本信息，同时账号将被禁用，无法登录应用；如果需要彻底删除账号，请调用删除接口。 *
  • 该操作不可恢复，请谨慎操作！ *
  • @param requestBody
  • @returns ResignUserRespDto

func (*ManagementClient) ResignUser 

func (client *ManagementClient) ResignUser(reqDto *dto.ResignUserReqDto) *dto.ResignUserRespDto
  • @summary 离职用户
  • @description 离职用户。离职操作会进行以下操作： *
  • - 离职后该成员授权、部门、角色、分组、岗位关系将被删除；
  • - 离职后将保留用户基本信息，同时账号将被禁用，无法登录应用；如果需要彻底删除账号，请调用删除接口。 *
  • 该操作不可恢复，请谨慎操作！ *
  • @param requestBody
  • @returns ResignUserRespDto

func (*ManagementClient) ResignUserBatch 

func (client *ManagementClient) ResignUserBatch(reqDto *dto.ResignUserBatchReqDto) *dto.ResignUserRespDto
  • @summary 批量离职用户
  • @description 批量离职用户。离职操作会进行以下操作： *
  • - 离职后该成员授权、部门、角色、分组、岗位关系将被删除；
  • - 离职后将保留用户基本信息，同时账号将被禁用，无法登录应用；如果需要彻底删除账号，请调用删除接口。 *
  • 该操作不可恢复，请谨慎操作！ *
  • @param requestBody
  • @returns ResignUserRespDto

func (*ManagementClient) ReuploadPipelineFunction 

func (client *ManagementClient) ReuploadPipelineFunction(reqDto *dto.ReUploadPipelineFunctionDto) *dto.PipelineFunctionSingleRespDto

* @summary 重新上传 Pipeline 函数 * @description 当 Pipeline 函数上传失败时，重新上传 Pipeline 函数 * @param requestBody * @returns PipelineFunctionSingleRespDto

func (*ManagementClient) RevokeApplicationAccess 

func (client *ManagementClient) RevokeApplicationAccess(reqDto *dto.RevokeApplicationAccessDto) *dto.IsSuccessRespDto

* @summary 删除应用访问授权记录 * @description 取消给用户、分组、组织或角色的应用访问权限授权,如果传入数据不存在，则返回数据不报错处理。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) RevokeDataPolicy added in v3.0.4 

func (client *ManagementClient) RevokeDataPolicy(reqDto *dto.DeleteAuthorizeDataPolicyDto) *dto.CommonResponseDto

* @summary 撤销数据策略 * @description 删除数据策略相关的主体授权，通过授权主体 ID、授权主体类型和数据策略 ID 进行删除。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) RevokeRole 

func (client *ManagementClient) RevokeRole(reqDto *dto.RevokeRoleDto) *dto.IsSuccessRespDto

* @summary 移除分配的角色 * @description 通过权限分组内角色 code，移除分配的角色，被分配者可以是用户或部门。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) RevokeRoleBatch added in v3.0.14 

func (client *ManagementClient) RevokeRoleBatch(reqDto *dto.RevokeRoleBatchDto) *dto.IsSuccessRespDto

* @summary 批量移除分配的角色 * @description 批量移除分配的角色，被分配者可以是用户，可以是部门 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SaveLdapConfigInfo added in v3.0.14 

func (client *ManagementClient) SaveLdapConfigInfo(reqDto *dto.LdapSaveDto) *dto.LdapOperateRespDto

* @summary 初始化/重启 LDAP server * @description 初始化/重启 LDAP server * @param requestBody * @returns LdapOperateRespDto

func (*ManagementClient) SearchDepartmentMembers 

func (client *ManagementClient) SearchDepartmentMembers(reqDto *dto.SearchDepartmentMembersDto) *dto.UserPaginatedRespDto

* @summary 搜索部门下的成员 * @description 通过组织 code、部门 ID、搜索关键词，搜索部门下的成员，支持分页，可以选择获取自定义数据、identities 等。 * @param organizationCode 组织 code * @param departmentId 部门 ID，根部门传 `root` * @param keywords 搜索关键词，如成员名称 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param departmentIdType 此次调用中使用的部门 ID 的类型 * @param includeChildrenDepartments 是否包含子部门的成员 * @param withCustomData 是否获取自定义数据 * @param withIdentities 是否获取 identities * @param withDepartmentIds 是否获取部门 ID 列表 * @param tenantId 租户 ID * @returns UserPaginatedRespDto

func (*ManagementClient) SearchDepartments 

func (client *ManagementClient) SearchDepartments(reqDto *dto.SearchDepartmentsReqDto) *dto.DepartmentListRespDto

* @deprecated * @summary 搜索部门 * @description 通过组织 code、搜索关键词，搜索部门，可以搜索组织名称等。 * @param requestBody * @returns DepartmentListRespDto

func (*ManagementClient) SearchDepartmentsList added in v3.0.4 

func (client *ManagementClient) SearchDepartmentsList(reqDto *dto.SearchDepartmentsListReqDto) *dto.DepartmentListRespDto

* @summary 搜索部门 * @description 通过组织 code、搜索关键词，搜索部门，可以搜索组织名称等。 * @param requestBody * @returns DepartmentListRespDto

func (*ManagementClient) SearchOrganizations 

func (client *ManagementClient) SearchOrganizations(reqDto *dto.SearchOrganizationsDto) *dto.OrganizationPaginatedRespDto

* @summary 搜索组织机构列表 * @description 通过搜索关键词，搜索组织机构列表，支持分页。 * @param keywords 搜索关键词，如组织机构名称 * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withCustomData 是否获取自定义数据 * @param tenantId 租户 ID * @returns OrganizationPaginatedRespDto

func (*ManagementClient) SendEmailBatch added in v3.0.14 

func (client *ManagementClient) SendEmailBatch(reqDto *dto.SendManyTenantEmailDto) *dto.SendEmailBatchDataDto

* @summary 导入租户通知邮箱用户 * @description 此接口用于批量发送邮件通知。 * @param requestBody * @returns SendEmailBatchDataDto

func (*ManagementClient) SendHttpRequest 

func (c *ManagementClient) SendHttpRequest(url string, method string, reqDto interface{}) ([]byte, error)

func (*ManagementClient) SendInviteTenantUserEmail added in v3.0.14 

func (client *ManagementClient) SendInviteTenantUserEmail(reqDto *dto.SendInviteTenantUserEmailDto) *dto.CommonResponseDto

* @summary 发送邀请租户用户邮件 * @description 向多个邮箱发送邀请成为租户用户的邮件 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) SendSmsBatch added in v3.0.14 

func (client *ManagementClient) SendSmsBatch(reqDto *dto.SendManyTenantSmsDto) *dto.SendSmsBatchRespDto

* @summary 导入租户短信通知用户 * @description 此接口用于批量发送短信通知。 * @param requestBody * @returns SendSmsBatchRespDto

func (*ManagementClient) SetCustomData 

func (client *ManagementClient) SetCustomData(reqDto *dto.SetCustomDataReqDto) *dto.IsSuccessRespDto

* @summary 设置自定义字段的值 * @description 给用户、角色或部门设置自定义字段的值，如果存在则更新，不存在则创建。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SetCustomFields 

func (client *ManagementClient) SetCustomFields(reqDto *dto.SetCustomFieldsReqDto) *dto.CustomFieldListRespDto

* @summary 创建/修改自定义字段定义 * @description 创建/修改用户、部门或角色自定义字段定义，如果传入的 key 不存在则创建，存在则更新。 * @param requestBody * @returns CustomFieldListRespDto

func (*ManagementClient) SetPublicAccountOfDepartments added in v3.0.14 

func (client *ManagementClient) SetPublicAccountOfDepartments(reqDto *dto.SetUserDepartmentsDto) *dto.IsSuccessRespDto

* @summary 设置公共账号所在部门 * @description 设置公共账号所在部门。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SetPublicAccountOfnPost added in v3.0.14 

func (client *ManagementClient) SetPublicAccountOfnPost(reqDto *dto.UserConnectionPostDto) *dto.CommonResponseDto

* @summary 设置公共账号的岗位 * @description 设置公共账号关联的岗位 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) SetTenantAdmin added in v3.0.14 

func (client *ManagementClient) SetTenantAdmin(reqDto *dto.RemoveTenantUsersDto) *dto.CommonResponseDto

* @summary 设置租户管理员 * @description 此接口用于根据用户 ID 或租户成员 ID 设置租户管理员。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) SetUserBaseFields 

func (client *ManagementClient) SetUserBaseFields(reqDto *dto.SetUserBaseFieldsReqDto) *dto.CustomFieldListRespDto

* @summary 修改用户内置字段配置 * @description 修改用户内置字段配置，内置字段不允许修改数据类型、唯一性。 * @param requestBody * @returns CustomFieldListRespDto

func (*ManagementClient) SetUserDepartments 

func (client *ManagementClient) SetUserDepartments(reqDto *dto.SetUserDepartmentsDto) *dto.IsSuccessRespDto

* @summary 设置用户所在部门 * @description 通过用户 ID，设置用户所在部门，可以选择指定用户 ID 类型等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SetUserPosts added in v3.0.14 

func (client *ManagementClient) SetUserPosts(reqDto *dto.SetUserPostsDto) *dto.CommonResponseDto

* @summary 用户设置岗位 * @description 一次性给用户设置岗位：如果之前的岗位不在传入的列表中，会进行移除；如果有新增的岗位，会加入到新的岗位；如果不变，则不进行任何操作。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) SetUsersMfaStatus added in v3.0.14 

func (client *ManagementClient) SetUsersMfaStatus(reqDto *dto.SetMfaStatusDto) *dto.IsSuccessRespDto

* @summary 设置用户 MFA 状态 * @description 设置用户 MFA 状态，即 MFA 触发数据。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SetuserOfPublicAccount added in v3.0.14 

func (client *ManagementClient) SetuserOfPublicAccount(reqDto *dto.SetUserOfPublicAccountBatchReqDto) *dto.IsSuccessRespDto

* @summary 用户绑定批量公共账号 * @description 用户绑定批量公共账号 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) SubEvent added in v3.0.10 

func (client *ManagementClient) SubEvent(eventCode string, onSuccess func(msg []byte), onError func(err error))

* @summary 事件订阅 * @description 根据事件编码订阅一个自定义事件 * @param eventCode 事件编码 * @param onSuccess 成功的消息 * @param onError 失败处理

func (*ManagementClient) SubEventByReceiver added in v3.0.10 

func (client *ManagementClient) SubEventByReceiver(eventCode string, receiver util.EventReceiver)

* @summary 事件订阅 * @description 根据事件编码订阅一个自定义事件 * @param eventCode 事件编码 * @param receiver 消息处理器

func (*ManagementClient) SuspendDevice added in v3.0.14 

func (client *ManagementClient) SuspendDevice(reqDto *dto.SuspendTerminalUserDto) *dto.CommonResponseDto

* @summary 挂起设备(用户详情页) * @description 挂起设备(用户详情页)。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) TriggerSyncRiskOperations 

func (client *ManagementClient) TriggerSyncRiskOperations(reqDto *dto.TriggerSyncRiskOperationDto) *dto.TriggerSyncRiskOperationsRespDto

* @summary 执行同步风险操作 * @description 执行同步风险操作 * @param requestBody * @returns TriggerSyncRiskOperationsRespDto

func (*ManagementClient) TriggerSyncTask 

func (client *ManagementClient) TriggerSyncTask(reqDto *dto.TriggerSyncTaskDto) *dto.TriggerSyncTaskRespDto

* @summary 执行同步任务 * @description 执行同步任务 * @param requestBody * @returns TriggerSyncTaskRespDto

func (*ManagementClient) TriggerWebhook 

func (client *ManagementClient) TriggerWebhook(reqDto *dto.TriggerWebhookDto) *dto.TriggerWebhookRespDto

* @summary 手动触发 Webhook 执行 * @description 通过指定 webhookId，可选请求头和请求体进行手动触发 webhook 执行 * @param requestBody * @returns TriggerWebhookRespDto

func (*ManagementClient) UnassignAsaAccount added in v3.0.4 

func (client *ManagementClient) UnassignAsaAccount(reqDto *dto.AssignAsaAccountsDto) *dto.IsSuccessRespDto

* @summary 取消分配 ASA 账号 * @description 取消分配给用户、组织、分组或角色的 ASA 账号 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UnbindPublicAccountOfPost added in v3.0.14 

func (client *ManagementClient) UnbindPublicAccountOfPost(reqDto *dto.UserConnectionPostDto) *dto.IsSuccessRespDto

* @summary 解绑公共账号关联岗位 * @description 解绑公共账号关联岗位 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UnbindUsersPublicAccount added in v3.0.14 

func (client *ManagementClient) UnbindUsersPublicAccount(reqDto *dto.UnbindPublicAccountBatchReqDto) *dto.IsSuccessRespDto

* @summary 公共账号解绑用户 * @description 公共账号解绑用户 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UnlinkIdentity added in v3.0.14 

func (client *ManagementClient) UnlinkIdentity(reqDto *dto.UnlinkIdentity) *dto.UnlinkIdentityResDto

* @summary 解除绑定用户在身份源下的所有身份信息 * @description 解除绑定用户在某个身份源下的所有身份信息。解绑后，将无法使用执行过解绑操作的身份源登录到对应的 Authing 用户，除非重新绑定身份信息。 * @param requestBody * @returns UnlinkIdentityResDto

func (*ManagementClient) UpdateAccessKey added in v3.0.7 

func (client *ManagementClient) UpdateAccessKey(reqDto *dto.UpdateAccessKeyDto) *dto.IsSuccessRespDto

* @summary 更新一个管理员 AccessKey * @description 根据 AccessKeyId 更新一个管理员 AccessKey，目前只支持更新 status，status 支持 activated / revoked * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateApplicationMfaSettings added in v3.0.14 

func (client *ManagementClient) UpdateApplicationMfaSettings(reqDto *dto.UpdateApplicationMfaSettingsDto) *dto.MFASettingsRespDto

* @summary 修改应用多因素认证配置 * @description 传入 MFA 认证因素列表进行开启或关闭 * @param requestBody * @returns MFASettingsRespDto

func (*ManagementClient) UpdateApplicationPermissionStrategy 

func (client *ManagementClient) UpdateApplicationPermissionStrategy(reqDto *dto.UpdateApplicationPermissionStrategyDataDto) *dto.IsSuccessRespDto

* @summary 更新应用默认访问授权策略 * @description 更新应用默认访问授权策略 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateAsaAccount added in v3.0.4 

func (client *ManagementClient) UpdateAsaAccount(reqDto *dto.UpdateAsaAccountDto) *dto.AsaAccountSingleRespDto

* @summary 更新 ASA 账号 * @description 更新某个 ASA 账号信息 * @param requestBody * @returns AsaAccountSingleRespDto

func (*ManagementClient) UpdateDataPolicy added in v3.0.4 

func (client *ManagementClient) UpdateDataPolicy(reqDto *dto.UpdateDataPolicyDto) *dto.UpdateDataPolicyResponseDto

* @summary 修改数据策略 * @description 修改数据策略，通过数据策略名称、数据策略描述和相关的数据资源等字段修改数据策略信息。 * @param requestBody * @returns UpdateDataPolicyResponseDto

func (*ManagementClient) UpdateDataResource added in v3.0.4 

func (client *ManagementClient) UpdateDataResource(reqDto *dto.UpdateDataResourceDto) *dto.UpdateDataResourceResponseDto

* @summary 修改数据资源 * @description 修改数据资源,根据权限空间 Code 和数据资源 Code 查询原始信息,只允许修改数据资源名称、描述和数据资源节点。 * @param requestBody * @returns UpdateDataResourceResponseDto

func (*ManagementClient) UpdateDepartment 

func (client *ManagementClient) UpdateDepartment(reqDto *dto.UpdateDepartmentReqDto) *dto.DepartmentSingleRespDto

* @summary 修改部门 * @description 通过组织 code、部门 ID，修改部门，可以设置多种参数。 * @param requestBody * @returns DepartmentSingleRespDto

func (*ManagementClient) UpdateEmailTemplate 

func (client *ManagementClient) UpdateEmailTemplate(reqDto *dto.UpdateEmailTemplateDto) *dto.EmailTemplateSingleItemRespDto

* @summary 修改邮件模版 * @description 修改邮件模版 * @param requestBody * @returns EmailTemplateSingleItemRespDto

func (*ManagementClient) UpdateExtIdp 

func (client *ManagementClient) UpdateExtIdp(reqDto *dto.UpdateExtIdpDto) *dto.ExtIdpSingleRespDto

* @summary 更新身份源配置 * @description 更新身份源配置，可以设置身份源 ID 与 名称。 * @param requestBody * @returns ExtIdpSingleRespDto

func (*ManagementClient) UpdateExtIdpConn 

func (client *ManagementClient) UpdateExtIdpConn(reqDto *dto.UpdateExtIdpConnDto) *dto.ExtIdpConnDetailSingleRespDto

* @summary 更新身份源连接 * @description 更新身份源连接，可以设置身份源图标、是否只支持登录等。 * @param requestBody * @returns ExtIdpConnDetailSingleRespDto

func (*ManagementClient) UpdateField added in v3.0.14 

func (client *ManagementClient) UpdateField(reqDto *dto.UpdateFunctionModelFieldDto) *dto.FunctionModelFieldResDto

* @summary 更新数据对象的字段 * @description 更新相关数据对象的字段信息及基本校验规则 * @param requestBody * @returns FunctionModelFieldResDto

func (*ManagementClient) UpdateGlobalMfaSettings 

func (client *ManagementClient) UpdateGlobalMfaSettings(reqDto *dto.MFASettingsDto) *dto.MFASettingsRespDto

* @summary 修改全局多因素认证配置 * @description 传入 MFA 认证因素列表进行开启, * @param requestBody * @returns MFASettingsRespDto

func (*ManagementClient) UpdateGroup 

func (client *ManagementClient) UpdateGroup(reqDto *dto.UpdateGroupReqDto) *dto.GroupSingleRespDto

* @summary 修改分组 * @description 通过分组 code，修改分组，可以修改此分组的 code。 * @param requestBody * @returns GroupSingleRespDto

func (*ManagementClient) UpdateLdapConfigInfo added in v3.0.14 

func (client *ManagementClient) UpdateLdapConfigInfo(reqDto *dto.LdapUpdateDto) *dto.LdapOperateRespDto

* @summary 更新 LDAP server 配置信息 * @description 更新 LDAP server 配置信息 * @param requestBody * @returns LdapOperateRespDto

func (*ManagementClient) UpdateLoginPageConfig added in v3.0.7 

func (client *ManagementClient) UpdateLoginPageConfig(reqDto *dto.UpdateLoginConfigDto) *dto.IsSuccessRespDto

* @summary 更新应用登录页配置 * @description 通过应用 ID 更新登录页配置。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateModel added in v3.0.14 

func (client *ManagementClient) UpdateModel(reqDto *dto.UpdateFunctionModelDto) *dto.FunctionModelResDto

* @summary 更新数据对象 * @description 更新对应功能 id 的数据对象信息 * @param requestBody * @returns FunctionModelResDto

func (*ManagementClient) UpdateMultipleTenantAdmin added in v3.0.14 

func (client *ManagementClient) UpdateMultipleTenantAdmin(reqDto *dto.UpdateMultipleTenantAdminDto) *dto.CommonResponseDto

* @summary 更新多租户管理员用户 * @description 根据用户 ID 更新一个用户池内拥有多租户管理权限的用户的信息 * @param userId 用户 ID * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UpdateNamespace 

func (client *ManagementClient) UpdateNamespace(reqDto *dto.UpdateNamespaceDto) *dto.UpdateNamespaceRespDto

* @summary 修改权限分组信息 * @description 修改权限分组信息，可以修改名称、描述信息以及新的唯一标志符(NewCode)。 * @param requestBody * @returns UpdateNamespaceRespDto

func (*ManagementClient) UpdateNodeStatus added in v3.0.14 

func (client *ManagementClient) UpdateNodeStatus(reqDto *dto.UpdateDepartmentStatusReqDto) *dto.Node

* @summary 更新部门状态 * @description 启用和禁用部门 * @param requestBody * @returns Node

func (*ManagementClient) UpdateOperate added in v3.0.14 

func (client *ManagementClient) UpdateOperate(reqDto *dto.UpdateOperateModelDto) *dto.CommonResponseDto

* @summary 更新操作管理 * @description 更新操作管理 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UpdateOrganization 

func (client *ManagementClient) UpdateOrganization(reqDto *dto.UpdateOrganizationReqDto) *dto.OrganizationSingleRespDto

* @summary 修改组织机构 * @description 通过组织 code，修改组织机构，可以选择部门描述、新组织 code、组织名称等。 * @param requestBody * @returns OrganizationSingleRespDto

func (*ManagementClient) UpdateOrganizationStatus added in v3.0.14 

func (client *ManagementClient) UpdateOrganizationStatus(reqDto *dto.UpdateOrganizationStatusReqDto) *dto.IsSuccessRespDto

* @summary 更新组织机构状态 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdatePermissionNamespace added in v3.0.4 

func (client *ManagementClient) UpdatePermissionNamespace(reqDto *dto.UpdatePermissionNamespaceDto) *dto.UpdatePermissionNamespaceResponseDto

* @summary 修改权限空间 * @description 修改权限空间，可以修改权限空间名称、权限空间描述信息以及权限空间新的唯一标志符(Code)。 * @param requestBody * @returns UpdatePermissionNamespaceResponseDto

func (*ManagementClient) UpdatePipelineFunction 

func (client *ManagementClient) UpdatePipelineFunction(reqDto *dto.UpdatePipelineFunctionDto) *dto.PipelineFunctionSingleRespDto

* @summary 修改 Pipeline 函数 * @description 修改 Pipeline 函数 * @param requestBody * @returns PipelineFunctionSingleRespDto

func (*ManagementClient) UpdatePipelineOrder 

func (client *ManagementClient) UpdatePipelineOrder(reqDto *dto.UpdatePipelineOrderDto) *dto.CommonResponseDto

* @summary 修改 Pipeline 函数顺序 * @description 修改 Pipeline 函数顺序 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UpdatePost added in v3.0.14 

func (client *ManagementClient) UpdatePost(reqDto *dto.CreatePostDto) *dto.CreatePostRespDto

* @summary 更新岗位信息 * @description 更新岗位信息 * @param requestBody * @returns CreatePostRespDto

func (*ManagementClient) UpdatePublicAccount added in v3.0.14 

func (client *ManagementClient) UpdatePublicAccount(reqDto *dto.UpdatePublicAccountReqDto) *dto.PublicAccountSingleRespDto

* @summary 修改公共账号资料 * @description 通过公共账号用户 ID，修改公共账号资料，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份修改公共账号资料因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns PublicAccountSingleRespDto

func (*ManagementClient) UpdatePublicAccountBatch added in v3.0.14 

func (client *ManagementClient) UpdatePublicAccountBatch(reqDto *dto.UpdatePublicAccountBatchReqDto) *dto.PublicAccountListRespDto

* @summary 批量修改公共账号资料 * @description 批量修改公共账号资料，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份修改公共账号资料因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns PublicAccountListRespDto

func (*ManagementClient) UpdateResource 

func (client *ManagementClient) UpdateResource(reqDto *dto.UpdateResourceDto) *dto.ResourceRespDto

* @summary 修改资源 * @description 修改资源，可以设置资源的描述、定义的操作类型、URL 标识等。 * @param requestBody * @returns ResourceRespDto

func (*ManagementClient) UpdateRole 

func (client *ManagementClient) UpdateRole(reqDto *dto.UpdateRoleDto) *dto.IsSuccessRespDto

* @summary 修改角色 * @description 通过权限分组(权限空间）内角色新旧 Code，修改角色，可以选择角色名称、角色描述等。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateRow added in v3.0.14 

func (client *ManagementClient) UpdateRow(reqDto *dto.UpdateRowDto) *dto.FunctionModelValueResDto

* @summary 更新行 * @description 更新行 * @param requestBody * @returns FunctionModelValueResDto

func (*ManagementClient) UpdateSecuritySettings 

func (client *ManagementClient) UpdateSecuritySettings(reqDto *dto.UpdateSecuritySettingsDto) *dto.SecuritySettingsRespDto

* @summary 修改安全配置 * @description 可选安全域、Authing Token 有效时间（秒）、验证码长度、验证码尝试次数、用户修改邮箱的安全策略、用户修改手机号的安全策略、Cookie 过期时间设置、是否禁止用户注册、频繁注册检测配置、验证码注册后是否要求用户设置密码、未验证的邮箱登录时是否禁止登录并发送认证邮件、用户自助解锁配置、Authing 登录页面是否开启登录账号选择、APP 扫码登录安全配置进行修改安全配置 * @param requestBody * @returns SecuritySettingsRespDto

func (*ManagementClient) UpdateSyncTask 

func (client *ManagementClient) UpdateSyncTask(reqDto *dto.UpdateSyncTaskDto) *dto.SyncTaskPaginatedRespDto

* @summary 修改同步任务 * @description 修改同步任务 * @param requestBody * @returns SyncTaskPaginatedRespDto

func (*ManagementClient) UpdateTenant added in v3.0.14 

func (client *ManagementClient) UpdateTenant(reqDto *dto.UpdateTenantDto) *dto.IsSuccessRespDto

* @summary 更新租户数据 * @description 此接口用于更新租户基本信息。 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateTenantCooperator added in v3.0.14 

func (client *ManagementClient) UpdateTenantCooperator(reqDto *dto.UpdateTenantCooperatorDto) *dto.CommonResponseDto

* @summary 更新协调管理员 * @description 根据用户 ID 更新一个协调管理员 * @param userId 用户 ID * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UpdateTenantQrCodeState added in v3.0.14 

func (client *ManagementClient) UpdateTenantQrCodeState(reqDto *dto.UpdateTenantAppqrcodeState) *dto.IsSuccessRespDto

* @summary 更新租户控制台扫码登录状态 * @description 更新租户控制台扫码登录状态 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateTenantUser added in v3.0.14 

func (client *ManagementClient) UpdateTenantUser(reqDto *dto.UpdateTenantUserDto) *dto.CommonResponseDto

* @summary 更新租户成员 * @description 此接口用于根据用户 ID 或租户成员 ID 更新租户成员。 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UpdateUser 

func (client *ManagementClient) UpdateUser(reqDto *dto.UpdateUserReqDto) *dto.UserSingleRespDto

* @summary 修改用户资料 * @description 通过用户 ID，修改用户资料，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份修改用户资料因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns UserSingleRespDto

func (*ManagementClient) UpdateUserBatch 

func (client *ManagementClient) UpdateUserBatch(reqDto *dto.UpdateUserBatchReqDto) *dto.UserListRespDto

* @summary 批量修改用户资料 * @description 批量修改用户资料，邮箱、手机号、用户名、externalId 用户池内唯一，此接口将以管理员身份修改用户资料因此不需要进行手机号验证码检验等安全检测。 * @param requestBody * @returns UserListRespDto

func (*ManagementClient) UpdateUserPoolTenantConfig added in v3.0.7 

func (client *ManagementClient) UpdateUserPoolTenantConfig(reqDto *dto.UpdateUserPoolTenantLoginConfigDto) *dto.IsSuccessRespDto

* @summary 更新用户池租户配置信息 * @description 更新用户池多租户配置内登录信息 * @param requestBody * @returns IsSuccessRespDto

func (*ManagementClient) UpdateWebhook 

func (client *ManagementClient) UpdateWebhook(reqDto *dto.UpdateWebhookDto) *dto.UpdateWebhooksRespDto

* @summary 修改 Webhook 配置 * @description 需要指定 webhookId，可选 Webhook 名称、Webhook 回调地址、请求数据格式、用户真实名称、是否启用、请求密钥参数进行修改 webhook * @param requestBody * @returns UpdateWebhooksRespDto

func (*ManagementClient) UserConnectionPost added in v3.0.14 

func (client *ManagementClient) UserConnectionPost(reqDto *dto.UserConnectionPostDto) *dto.CommonResponseDto

* @summary 用户关联岗位 * @description 用户关联岗位 * @param requestBody * @returns CommonResponseDto

func (*ManagementClient) UserFieldDecrypt added in v3.0.14 

func (client *ManagementClient) UserFieldDecrypt(reqDto *dto.UserFieldDecryptReqDto) *dto.UserFieldDecryptRespDto

* @summary 用户属性解密 * @description 接口接收加密信息，返回解密信息 * @param requestBody * @returns UserFieldDecryptRespDto

func (*ManagementClient) UserpollTenantConfig added in v3.0.7 

func (client *ManagementClient) UserpollTenantConfig() *dto.UserPoolTenantConfigDtoRespDto

* @summary 获取用户池租户配置信息 * @description 根据用户池 ID 获取用户池多租户配置信息 * @returns UserPoolTenantConfigDtoRespDto

func (*ManagementClient) VerifyEvent added in v3.0.14 

func (client *ManagementClient) VerifyEvent(reqDto *dto.PubEventDto) *dto.PubEventRespDto

* @summary 推送自定义事件 * @description 向 Authing 事件中心推送自定义事件 * @param requestBody * @returns PubEventRespDto

type ManagementClientOptions 

type ManagementClientOptions struct {
	AccessKeyId     string
	AccessKeySecret string
	TenantId        string
	//Deprecated: Use ReadTimeout instead
	Timeout     int
	ReadTimeout time.Duration
	Lang        string
	Host        string
	/**
	是否跳过 HTTPS 证书检测，默认为 false；如果是私有化部署的场景且证书不被信任，可以设置为 true
	*/
	InsecureSkipVerify bool
	WssHost            string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.