management

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) AssignRole ¶

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

* @summary 分配角色 * @description 通过权限分组内角色 code，分配角色，被分配者可以是用户或部门。 * @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) AuthorizeResources ¶

func (client *ManagementClient) AuthorizeResources(reqDto *dto.AuthorizeResourcesDto) *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) 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) CheckDomainAvailable ¶

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

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

func (*ManagementClient) CheckSessionStatus ¶

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

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

func (*ManagementClient) ConfigEmailProvider ¶

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

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

func (*ManagementClient) CreateApplication ¶

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

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

func (*ManagementClient) CreateDepartment ¶

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

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

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) 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) CreateNamespace ¶

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

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

func (*ManagementClient) CreateNamespacesBatch ¶

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

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

func (*ManagementClient) CreateOrganization ¶

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

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

func (*ManagementClient) CreatePipelineFunction ¶

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

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

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) CreateSyncTask ¶

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

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

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) CreateWebhook ¶

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

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

func (*ManagementClient) DeleteApplication ¶

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

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

func (*ManagementClient) DeleteDepartment ¶

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

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

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) DeleteNamespace ¶

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

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

func (*ManagementClient) DeleteNamespacesBatch ¶

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

* @summary 批量删除权限分组 * @description 分别通过权限分组唯一标志符，批量删除权限分组。 * @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) DeletePipelineFunction ¶

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

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

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) DeleteRolesBatch ¶

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

* @summary 删除角色 * @description 删除角色，可以批量删除。 * @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) 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) GetAdminAuditLogs ¶

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

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

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) 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) 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 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) * @returns CustomFieldListRespDto

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 是否获取自定义数据 * @returns DepartmentSingleRespDto

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) 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 * @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) GetMauPeriodUsageHistory ¶

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

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

func (*ManagementClient) GetNamespace ¶

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

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

func (*ManagementClient) GetNamespacesBatch ¶

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

* @summary 批量获取权限分组详情 * @description 分别通过权限分组唯一标志符，批量获取权限分组详情。 * @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 是否获取自定义数据 * @returns OrganizationSingleRespDto

func (*ManagementClient) GetOrganizationsBatch ¶

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

* @summary 批量获取组织机构详情 * @description 批量获取组织机构详情 * @param organizationCodeList 组织 Code（organizationCode）列表 * @param withCustomData 是否获取自定义数据 * @returns OrganizationListRespDto

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 是否获取自定义数据 * @returns DepartmentSingleRespDto

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) 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) 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) 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`。 * * @param withCustomData 是否获取自定义数据 * @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`。 * * @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`。 * * @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`。 * * @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`。 * * @param withCustomData 是否获取自定义数据 * @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`。 * * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param withCustomData 是否获取自定义数据 * @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`。 * * @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`。 * * @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`。 * * @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`。 * * @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`。 * * @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`。 * * @returns UserMfaSingleRespDto

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`。 * * @returns PrincipalAuthenticationInfoPaginatedRespDto

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`。 * * @param namespace 所属权限分组的 code * @returns RolePaginatedRespDto

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) ImportOtp ¶

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

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

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 是否包含子部门 * @returns IsUserInDepartmentRespDto

func (*ManagementClient) KickUsers ¶

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

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

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 page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @param isIntegrateApp 是否为集成应用 * @param isSelfBuiltApp 是否为自建应用 * @param ssoEnabled 是否开启单点登录 * @param keywords 模糊搜索字符串 * @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) ListChildrenDepartments ¶

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

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

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 的类型 * @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 列表 * @returns UserPaginatedRespDto

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) 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 * @returns GroupPaginatedRespDto

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 是否获取自定义数据 * @returns OrganizationPaginatedRespDto

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) 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) 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 keywords 用于根据角色的 code 进行模糊搜索，可选。 * @param namespace 所属权限分组的 code * @param page 当前页数，从 1 开始 * @param limit 每页数目，最大不能超过 50，默认为 10 * @returns RolePaginatedRespDto

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) 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) 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": "lastLoginTime",
• "operator": "BETWEEN",
• "value": [
• new Date(Date.now() - 14 * 24 * 60 * 60 * 1000),
• new Date(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 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) PreviewEmailTemplate ¶

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

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

func (*ManagementClient) RefreshApplicationSecret ¶

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

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

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) ResetUserPrincipalAuthenticationInfo ¶

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

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

func (*ManagementClient) ResignUser ¶

func (client *ManagementClient) ResignUser(reqDto *dto.ResignUserReqDto) *dto.ResignUserRespDto

* @summary 用户离职 * @description 通过用户 ID，对用户进行离职操作 * @param requestBody * @returns ResignUserRespDto

func (*ManagementClient) ResignUserBatch ¶

func (client *ManagementClient) ResignUserBatch(reqDto *dto.ResignUserBatchReqDto) *dto.ResignUserRespDto

* @summary 批量用户离职 * @description 通过用户 ID，对用户进行离职操作 * @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) RevokeRole ¶

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

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

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 列表 * @returns UserPaginatedRespDto

func (*ManagementClient) SearchDepartments ¶

func (client *ManagementClient) SearchDepartments(reqDto *dto.SearchDepartmentsReqDto) *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 是否获取自定义数据 * @returns OrganizationPaginatedRespDto

func (*ManagementClient) SendHttpRequest ¶

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

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) 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) 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) UpdateApplicationPermissionStrategy ¶

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

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

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) 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) UpdateNamespace ¶

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

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

func (*ManagementClient) UpdateOrganization ¶

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

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

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) 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) 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) 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) UpdateWebhook ¶

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

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