add identity controller summary

modules/identity/Sanhe.Abp.Identity.Application.Contracts/Sanhe/Abp/Identity/Dto/OrganizationUnitAddUserDto.cs

@@ -6,6 +6,9 @@ namespace Sanhe.Abp.Identity.Dto
 {
     public class OrganizationUnitAddUserDto
     {
+        /// <summary>
+        /// 用户Id
+        /// </summary>
         [Required]
         public List<Guid> UserIds { get; set; }
     }

modules/identity/Sanhe.Abp.Identity.Application.Contracts/Sanhe/Abp/Identity/Dto/OrganizationUnitCreateDto.cs

@@ -8,10 +8,15 @@ namespace Sanhe.Abp.Identity.Dto
 {
     public class OrganizationUnitCreateDto : ExtensibleObject
     {
+        /// <summary>
+        /// 显示名称
+        /// </summary>
         [Required]
         [DynamicStringLength(typeof(OrganizationUnitConsts), nameof(OrganizationUnitConsts.MaxDisplayNameLength))]
         public string DisplayName { get; set; }
-
+        /// <summary>
+        /// 父Id
+        /// </summary>
         public Guid? ParentId { get; set; }
     }
 }

modules/identity/Sanhe.Abp.Identity.Application.Contracts/Sanhe/Abp/Identity/Dto/OrganizationUnitGetChildrenDto.cs

@@ -6,8 +6,14 @@ namespace Sanhe.Abp.Identity.Dto
 {
     public class OrganizationUnitGetChildrenDto : IEntityDto<Guid>
     {
+        /// <summary>
+        /// Id
+        /// </summary>
         [Required]
         public Guid Id { get; set; }
+        /// <summary>
+        /// 是否递归查询
+        /// </summary>
         public bool Recursive { get; set; }
     }
 }

modules/identity/Sanhe.Abp.Identity.HttpApi/Sanhe/Abp/Identity/IdentityClaimTypeController.cs

@@ -16,47 +16,78 @@ namespace Sanhe.Abp.Identity
     public class IdentityClaimTypeController : AbpController, IIdentityClaimTypeAppService
     {
         protected IIdentityClaimTypeAppService IdentityClaimTypeAppService { get; }
+
         public IdentityClaimTypeController(IIdentityClaimTypeAppService identityClaimTypeAppService)
         {
             IdentityClaimTypeAppService = identityClaimTypeAppService;
         }
 
+        /// <summary>
+        /// 创建
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
-        public virtual async Task<IdentityClaimTypeDto> CreateAsync(IdentityClaimTypeCreateDto input)
+        public async virtual Task<IdentityClaimTypeDto> CreateAsync(IdentityClaimTypeCreateDto input)
         {
             return await IdentityClaimTypeAppService.CreateAsync(input);
         }
 
+        /// <summary>
+        /// 删除
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}")]
-        public virtual async Task DeleteAsync(Guid id)
+        public async virtual Task DeleteAsync(Guid id)
         {
             await IdentityClaimTypeAppService.DeleteAsync(id);
         }
 
+        /// <summary>
+        /// 获取所有
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("actived-list")]
-        public virtual async Task<ListResultDto<IdentityClaimTypeDto>> GetAllListAsync()
+        public async virtual Task<ListResultDto<IdentityClaimTypeDto>> GetAllListAsync()
         {
             return await IdentityClaimTypeAppService.GetAllListAsync();
         }
 
+        /// <summary>
+        /// 根据Id获取
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}")]
-        public virtual async Task<IdentityClaimTypeDto> GetAsync(Guid id)
+        public async virtual Task<IdentityClaimTypeDto> GetAsync(Guid id)
         {
             return await IdentityClaimTypeAppService.GetAsync(id);
         }
 
+        /// <summary>
+        /// 分页获取
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
-        public virtual async Task<PagedResultDto<IdentityClaimTypeDto>> GetListAsync(IdentityClaimTypeGetByPagedDto input)
+        public async virtual Task<PagedResultDto<IdentityClaimTypeDto>> GetListAsync(IdentityClaimTypeGetByPagedDto input)
         {
             return await IdentityClaimTypeAppService.GetListAsync(input);
         }
 
+        /// <summary>
+        /// 根据Id修改
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}")]
-        public virtual async Task<IdentityClaimTypeDto> UpdateAsync(Guid id, IdentityClaimTypeUpdateDto input)
+        public async virtual Task<IdentityClaimTypeDto> UpdateAsync(Guid id, IdentityClaimTypeUpdateDto input)
         {
             return await IdentityClaimTypeAppService.UpdateAsync(id, input);
         }

modules/identity/Sanhe.Abp.Identity.HttpApi/Sanhe/Abp/Identity/IdentityRoleController.cs

@@ -16,31 +16,48 @@ namespace Sanhe.Abp.Identity
     public class IdentityRoleController : AbpController, IIdentityRoleAppService
     {
         protected IIdentityRoleAppService RoleAppService { get; }
-        public IdentityRoleController(
-            IIdentityRoleAppService roleAppService)
+
+        public IdentityRoleController(IIdentityRoleAppService roleAppService)
         {
             RoleAppService = roleAppService;
         }
 
         #region OrganizationUnit
 
+        /// <summary>
+        /// 获取角色组织单元
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/organization-units")]
-        public virtual async Task<ListResultDto<OrganizationUnitDto>> GetOrganizationUnitsAsync(Guid id)
+        public async virtual Task<ListResultDto<OrganizationUnitDto>> GetOrganizationUnitsAsync(Guid id)
         {
             return await RoleAppService.GetOrganizationUnitsAsync(id);
         }
 
+        /// <summary>
+        /// 修改角色组织单元
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/organization-units")]
-        public virtual async Task SetOrganizationUnitsAsync(Guid id, IdentityRoleAddOrRemoveOrganizationUnitDto input)
+        public async virtual Task SetOrganizationUnitsAsync(Guid id, IdentityRoleAddOrRemoveOrganizationUnitDto input)
         {
             await RoleAppService.SetOrganizationUnitsAsync(id, input);
         }
 
+        /// <summary>
+        /// 删除角色组织单元
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="ouId"></param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}/organization-units/{ouId}")]
-        public virtual async Task RemoveOrganizationUnitsAsync(Guid id, Guid ouId)
+        public async virtual Task RemoveOrganizationUnitsAsync(Guid id, Guid ouId)
         {
             await RoleAppService.RemoveOrganizationUnitsAsync(id, ouId);
         }
@@ -49,34 +66,56 @@ namespace Sanhe.Abp.Identity
 
         #region Claim
 
+        /// <summary>
+        /// 获取角色身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/claims")]
-        public virtual async Task<ListResultDto<IdentityClaimDto>> GetClaimsAsync(Guid id)
+        public async virtual Task<ListResultDto<IdentityClaimDto>> GetClaimsAsync(Guid id)
         {
             return await RoleAppService.GetClaimsAsync(id);
         }
 
+        /// <summary>
+        /// 创建角色身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
         [Route("{id}/claims")]
-        public virtual async Task AddClaimAsync(Guid id, IdentityRoleClaimCreateDto input)
+        public async virtual Task AddClaimAsync(Guid id, IdentityRoleClaimCreateDto input)
         {
             await RoleAppService.AddClaimAsync(id, input);
         }
 
+        /// <summary>
+        /// 修改角色身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/claims")]
-        public virtual async Task UpdateClaimAsync(Guid id, IdentityRoleClaimUpdateDto input)
+        public async virtual Task UpdateClaimAsync(Guid id, IdentityRoleClaimUpdateDto input)
         {
             await RoleAppService.UpdateClaimAsync(id, input);
         }
 
+        /// <summary>
+        /// 删除角色身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}/claims")]
-        public virtual async Task DeleteClaimAsync(Guid id, IdentityRoleClaimDeleteDto input)
+        public async virtual Task DeleteClaimAsync(Guid id, IdentityRoleClaimDeleteDto input)
         {
             await RoleAppService.DeleteClaimAsync(id, input);
         }
-
         #endregion
     }
 }

modules/identity/Sanhe.Abp.Identity.HttpApi/Sanhe/Abp/Identity/IdentityUserController.cs

@@ -16,31 +16,48 @@ namespace Sanhe.Abp.Identity
     public class IdentityUserController : AbpController, IIdentityUserAppService
     {
         protected IIdentityUserAppService UserAppService { get; }
-        public IdentityUserController(
-            IIdentityUserAppService userAppService)
+
+        public IdentityUserController(IIdentityUserAppService userAppService)
         {
             UserAppService = userAppService;
         }
 
         #region OrganizationUnit
 
+        /// <summary>
+        /// 获取该用户的组织单位
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/organization-units")]
-        public virtual async Task<ListResultDto<OrganizationUnitDto>> GetOrganizationUnitsAsync(Guid id)
+        public async virtual Task<ListResultDto<OrganizationUnitDto>> GetOrganizationUnitsAsync(Guid id)
         {
             return await UserAppService.GetOrganizationUnitsAsync(id);
         }
 
+        /// <summary>
+        /// 修改该用户组织单位
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/organization-units")]
-        public virtual async Task SetOrganizationUnitsAsync(Guid id, IdentityUserOrganizationUnitUpdateDto input)
+        public async virtual Task SetOrganizationUnitsAsync(Guid id, IdentityUserOrganizationUnitUpdateDto input)
         {
             await UserAppService.SetOrganizationUnitsAsync(id, input);
         }
 
+        /// <summary>
+        /// 删除该用户组织单位
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="ouId"></param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}/organization-units/{ouId}")]
-        public virtual async Task RemoveOrganizationUnitsAsync(Guid id, Guid ouId)
+        public async virtual Task RemoveOrganizationUnitsAsync(Guid id, Guid ouId)
         {
             await UserAppService.RemoveOrganizationUnitsAsync(id, ouId);
         }
@@ -49,54 +66,93 @@ namespace Sanhe.Abp.Identity
 
         #region Claim
 
+        /// <summary>
+        /// 获取用户身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/claims")]
-        public virtual async Task<ListResultDto<IdentityClaimDto>> GetClaimsAsync(Guid id)
+        public async virtual Task<ListResultDto<IdentityClaimDto>> GetClaimsAsync(Guid id)
         {
             return await UserAppService.GetClaimsAsync(id);
         }
 
+        /// <summary>
+        /// 创建用户身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
         [Route("{id}/claims")]
-        public virtual async Task AddClaimAsync(Guid id, IdentityUserClaimCreateDto input)
+        public async virtual Task AddClaimAsync(Guid id, IdentityUserClaimCreateDto input)
         {
             await UserAppService.AddClaimAsync(id, input);
         }
 
+        /// <summary>
+        /// 修改用户身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/claims")]
-        public virtual async Task UpdateClaimAsync(Guid id, IdentityUserClaimUpdateDto input)
+        public async virtual Task UpdateClaimAsync(Guid id, IdentityUserClaimUpdateDto input)
         {
             await UserAppService.UpdateClaimAsync(id, input);
         }
 
+        /// <summary>
+        /// 删除用户身份声明
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}/claims")]
-        public virtual async Task DeleteClaimAsync(Guid id, IdentityUserClaimDeleteDto input)
+        public async virtual Task DeleteClaimAsync(Guid id, IdentityUserClaimDeleteDto input)
         {
             await UserAppService.DeleteClaimAsync(id, input);
         }
 
         #endregion
 
-
+        /// <summary>
+        /// 变更用户双因素验证选项
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("change-two-factor")]
-        public virtual async Task ChangeTwoFactorEnabledAsync(Guid id, TwoFactorEnabledDto input)
+        public async virtual Task ChangeTwoFactorEnabledAsync(Guid id, TwoFactorEnabledDto input)
         {
             await UserAppService.ChangeTwoFactorEnabledAsync(id, input);
         }
 
+        /// <summary>
+        /// 锁定
+        /// </summary>
+        /// <param name="id">用户Id</param>
+        /// <param name="seconds">秒</param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/lock/{seconds}")]
-        public virtual async Task LockAsync(Guid id, int seconds)
+        public async virtual Task LockAsync(Guid id, int seconds)
         {
             await UserAppService.LockAsync(id, seconds);
         }
 
+        /// <summary>
+        /// 解锁
+        /// </summary>
+        /// <param name="id">用户Id</param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/unlock")]
-        public virtual async Task UnLockAsync(Guid id)
+        public async virtual Task UnLockAsync(Guid id)
         {
             await UserAppService.UnLockAsync(id);
         }

modules/identity/Sanhe.Abp.Identity.HttpApi/Sanhe/Abp/Identity/OrganizationUnitController.cs

@@ -17,125 +17,215 @@ namespace Sanhe.Abp.Identity
     {
         protected IOrganizationUnitAppService OrganizationUnitAppService { get; }
 
-        public OrganizationUnitController(
-            IOrganizationUnitAppService organizationUnitAppService)
+        public OrganizationUnitController(IOrganizationUnitAppService organizationUnitAppService)
         {
             OrganizationUnitAppService = organizationUnitAppService;
         }
 
+        /// <summary>
+        /// 创建组织单位
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
-        public virtual async Task<OrganizationUnitDto> CreateAsync(OrganizationUnitCreateDto input)
+        public async virtual Task<OrganizationUnitDto> CreateAsync(OrganizationUnitCreateDto input)
         {
             return await OrganizationUnitAppService.CreateAsync(input);
         }
 
+        /// <summary>
+        /// 删除组织单位
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <returns></returns>
         [HttpDelete]
         [Route("{id}")]
-        public virtual async Task DeleteAsync(Guid id)
+        public async virtual Task DeleteAsync(Guid id)
         {
             await OrganizationUnitAppService.DeleteAsync(id);
         }
 
+        /// <summary>
+        /// 查找子单位
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("find-children")]
-        public virtual async Task<ListResultDto<OrganizationUnitDto>> FindChildrenAsync(OrganizationUnitGetChildrenDto input)
+        public async virtual Task<ListResultDto<OrganizationUnitDto>> FindChildrenAsync(OrganizationUnitGetChildrenDto input)
         {
             return await OrganizationUnitAppService.FindChildrenAsync(input);
         }
 
+        /// <summary>
+        /// 获取组织单位信息
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}")]
-        public virtual async Task<OrganizationUnitDto> GetAsync(Guid id)
+        public async virtual Task<OrganizationUnitDto> GetAsync(Guid id)
         {
             return await OrganizationUnitAppService.GetAsync(id);
         }
 
+        /// <summary>
+        /// 获取根组织单位
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("root-node")]
-        public virtual async Task<ListResultDto<OrganizationUnitDto>> GetRootAsync()
+        public async virtual Task<ListResultDto<OrganizationUnitDto>> GetRootAsync()
         {
             return await OrganizationUnitAppService.GetRootAsync();
         }
 
+        /// <summary>
+        /// 最后一个组织节点
+        /// </summary>
+        /// <param name="parentId">父Id</param>
+        /// <returns></returns>
         [HttpGet]
         [Route("last-children")]
-        public virtual async Task<OrganizationUnitDto> GetLastChildOrNullAsync(Guid? parentId)
+        public async virtual Task<OrganizationUnitDto> GetLastChildOrNullAsync(Guid? parentId)
         {
             return await OrganizationUnitAppService.GetLastChildOrNullAsync(parentId);
         }
 
+        /// <summary>
+        /// 获取所有组织单位
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         [Route("all")]
-        public virtual async Task<ListResultDto<OrganizationUnitDto>> GetAllListAsync()
+        public async virtual Task<ListResultDto<OrganizationUnitDto>> GetAllListAsync()
         {
             return await OrganizationUnitAppService.GetAllListAsync();
         }
 
+        /// <summary>
+        /// 分页获取
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
-        public virtual async Task<PagedResultDto<OrganizationUnitDto>> GetListAsync(OrganizationUnitGetByPagedDto input)
+        public async virtual Task<PagedResultDto<OrganizationUnitDto>> GetListAsync(OrganizationUnitGetByPagedDto input)
         {
             return await OrganizationUnitAppService.GetListAsync(input);
         }
 
+        /// <summary>
+        /// 获取该组织单位所有角色名称
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/role-names")]
-        public virtual async Task<ListResultDto<string>> GetRoleNamesAsync(Guid id)
+        public async virtual Task<ListResultDto<string>> GetRoleNamesAsync(Guid id)
         {
             return await OrganizationUnitAppService.GetRoleNamesAsync(id);
         }
 
+        /// <summary>
+        /// 分页获取未添加的角色
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/unadded-roles")]
-        public virtual async Task<PagedResultDto<IdentityRoleDto>> GetUnaddedRolesAsync(Guid id, OrganizationUnitGetUnaddedRoleByPagedDto input)
+        public async virtual Task<PagedResultDto<IdentityRoleDto>> GetUnaddedRolesAsync(Guid id, OrganizationUnitGetUnaddedRoleByPagedDto input)
         {
             return await OrganizationUnitAppService.GetUnaddedRolesAsync(id, input);
         }
 
+        /// <summary>
+        /// 分页获取组织单位角色
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/roles")]
-        public virtual async Task<PagedResultDto<IdentityRoleDto>> GetRolesAsync(Guid id, PagedAndSortedResultRequestDto input)
+        public async virtual Task<PagedResultDto<IdentityRoleDto>> GetRolesAsync(Guid id, PagedAndSortedResultRequestDto input)
         {
             return await OrganizationUnitAppService.GetRolesAsync(id, input);
         }
 
+        /// <summary>
+        /// 分页获取未添加的用户
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/unadded-users")]
-        public virtual async Task<PagedResultDto<IdentityUserDto>> GetUnaddedUsersAsync(Guid id, OrganizationUnitGetUnaddedUserByPagedDto input)
+        public async virtual Task<PagedResultDto<IdentityUserDto>> GetUnaddedUsersAsync(Guid id, OrganizationUnitGetUnaddedUserByPagedDto input)
         {
             return await OrganizationUnitAppService.GetUnaddedUsersAsync(id, input);
         }
 
+        /// <summary>
+        /// 分页获取组织单位下用户
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <param name="input">分页参数</param>
+        /// <returns></returns>
         [HttpGet]
         [Route("{id}/users")]
-        public virtual async Task<PagedResultDto<IdentityUserDto>> GetUsersAsync(Guid id, GetIdentityUsersInput input)
+        public async virtual Task<PagedResultDto<IdentityUserDto>> GetUsersAsync(Guid id, GetIdentityUsersInput input)
         {
             return await OrganizationUnitAppService.GetUsersAsync(id, input);
         }
 
+        /// <summary>
+        /// 指定组织单位下添加用户
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
         [Route("{id}/users")]
-        public virtual async Task AddUsersAsync(Guid id, OrganizationUnitAddUserDto input)
+        public async virtual Task AddUsersAsync(Guid id, OrganizationUnitAddUserDto input)
         {
             await OrganizationUnitAppService.AddUsersAsync(id, input);
         }
 
+        /// <summary>
+        /// 指定组织单位下添加角色
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPost]
         [Route("{id}/roles")]
-        public virtual async Task AddRolesAsync(Guid id, OrganizationUnitAddRoleDto input)
+        public async virtual Task AddRolesAsync(Guid id, OrganizationUnitAddRoleDto input)
         {
             await OrganizationUnitAppService.AddRolesAsync(id, input);
         }
 
+        /// <summary>
+        /// 移动
+        /// </summary>
+        /// <param name="id"></param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}/move")]
-        public virtual async Task MoveAsync(Guid id, OrganizationUnitMoveDto input)
+        public async virtual Task MoveAsync(Guid id, OrganizationUnitMoveDto input)
         {
             await OrganizationUnitAppService.MoveAsync(id, input);
         }
 
+        /// <summary>
+        /// 修改组织单位信息
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <param name="input"></param>
+        /// <returns></returns>
         [HttpPut]
         [Route("{id}")]
-        public virtual async Task<OrganizationUnitDto> UpdateAsync(Guid id, OrganizationUnitUpdateDto input)
+        public async virtual Task<OrganizationUnitDto> UpdateAsync(Guid id, OrganizationUnitUpdateDto input)
         {
             return await OrganizationUnitAppService.UpdateAsync(id, input);
         }