Show / Hide Table of Contents

Class IdentityUserController

Inheritance
object
IdentityUserController
Implements
IIdentityUserAppService
ICrudAppService<IdentityUserDto, Guid, GetIdentityUsersInput, IdentityUserCreateDto, IdentityUserUpdateDto>
ICrudAppService<IdentityUserDto, IdentityUserDto, Guid, GetIdentityUsersInput, IdentityUserCreateDto, IdentityUserUpdateDto>
IReadOnlyAppService<IdentityUserDto, IdentityUserDto, Guid, GetIdentityUsersInput>
IApplicationService
IRemoteService
ICreateUpdateAppService<IdentityUserDto, Guid, IdentityUserCreateDto, IdentityUserUpdateDto>
ICreateAppService<IdentityUserDto, IdentityUserCreateDto>
IUpdateAppService<IdentityUserDto, Guid, IdentityUserUpdateDto>
IDeleteAppService<Guid>
Namespace: Volo.Abp.Identity
Assembly: Volo.Abp.Identity.Pro.HttpApi.dll
Syntax
[Area("identity")]
[Route("api/identity/users")]
public class IdentityUserController : AbpControllerBase, IIdentityUserAppService, ICrudAppService<IdentityUserDto, Guid, GetIdentityUsersInput, IdentityUserCreateDto, IdentityUserUpdateDto>, ICrudAppService<IdentityUserDto, IdentityUserDto, Guid, GetIdentityUsersInput, IdentityUserCreateDto, IdentityUserUpdateDto>, IReadOnlyAppService<IdentityUserDto, IdentityUserDto, Guid, GetIdentityUsersInput>, IApplicationService, IRemoteService, ICreateUpdateAppService<IdentityUserDto, Guid, IdentityUserCreateDto, IdentityUserUpdateDto>, ICreateAppService<IdentityUserDto, IdentityUserCreateDto>, IUpdateAppService<IdentityUserDto, Guid, IdentityUserUpdateDto>, IDeleteAppService<Guid>

Constructors

IdentityUserController(IIdentityUserAppService)

Declaration
public IdentityUserController(IIdentityUserAppService userAppService)
Parameters
Type Name Description
IIdentityUserAppService userAppService

Properties

UserAppService

Declaration
protected IIdentityUserAppService UserAppService { get; }
Property Value
Type Description
IIdentityUserAppService

Methods

CreateAsync(IdentityUserCreateDto)

Declaration
[HttpPost]
public virtual Task<IdentityUserDto> CreateAsync(IdentityUserCreateDto input)
Parameters
Type Name Description
IdentityUserCreateDto input
Returns
Type Description
Task<IdentityUserDto>

DeleteAsync(Guid)

Declaration
[HttpDelete]
[Route("{id}")]
public virtual Task DeleteAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task

FindByEmailAsync(string)

Declaration
[HttpGet]
[Route("by-email/{email}")]
public virtual Task<IdentityUserDto> FindByEmailAsync(string email)
Parameters
Type Name Description
string email
Returns
Type Description
Task<IdentityUserDto>

FindByIdAsync(Guid)

Declaration
[HttpGet]
[Route("by-id/{id}")]
public virtual Task<IdentityUserDto> FindByIdAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<IdentityUserDto>

FindByUsernameAsync(string)

Declaration
[HttpGet]
[Route("by-username/{username}")]
public virtual Task<IdentityUserDto> FindByUsernameAsync(string username)
Parameters
Type Name Description
string username
Returns
Type Description
Task<IdentityUserDto>

GetAllClaimTypesAsync()

Declaration
[HttpGet]
[Route("all-claim-types")]
public virtual Task<List<ClaimTypeDto>> GetAllClaimTypesAsync()
Returns
Type Description
Task<List<ClaimTypeDto>>

GetAssignableRolesAsync()

Declaration
[HttpGet]
[Route("assignable-roles")]
public Task<ListResultDto<IdentityRoleDto>> GetAssignableRolesAsync()
Returns
Type Description
Task<ListResultDto<IdentityRoleDto>>

GetAsync(Guid)

Declaration
[HttpGet]
[Route("{id}")]
public virtual Task<IdentityUserDto> GetAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<IdentityUserDto>

GetAvailableOrganizationUnitsAsync()

Declaration
[HttpGet]
[Route("available-organization-units")]
public Task<ListResultDto<OrganizationUnitWithDetailsDto>> GetAvailableOrganizationUnitsAsync()
Returns
Type Description
Task<ListResultDto<OrganizationUnitWithDetailsDto>>

GetClaimsAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/claims")]
public virtual Task<List<IdentityUserClaimDto>> GetClaimsAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<List<IdentityUserClaimDto>>

GetDownloadTokenAsync()

Declaration
[HttpGet]
[Route("download-token")]
public Task<DownloadTokenResultDto> GetDownloadTokenAsync()
Returns
Type Description
Task<DownloadTokenResultDto>

GetExternalLoginProvidersAsync()

Declaration
[HttpGet]
[Route("external-login-Providers")]
public virtual Task<List<ExternalLoginProviderDto>> GetExternalLoginProvidersAsync()
Returns
Type Description
Task<List<ExternalLoginProviderDto>>

GetImportInvalidUsersFileAsync(GetImportInvalidUsersFileInput)

Declaration
[HttpGet]
[Route("download-import-invalid-users-file")]
public Task<IRemoteStreamContent> GetImportInvalidUsersFileAsync(GetImportInvalidUsersFileInput input)
Parameters
Type Name Description
GetImportInvalidUsersFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetImportUsersSampleFileAsync(GetImportUsersSampleFileInput)

Declaration
[HttpGet]
[Route("import-users-sample-file")]
public Task<IRemoteStreamContent> GetImportUsersSampleFileAsync(GetImportUsersSampleFileInput input)
Parameters
Type Name Description
GetImportUsersSampleFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetListAsCsvFileAsync(GetIdentityUserListAsFileInput)

Declaration
[HttpGet]
[Route("export-as-csv")]
[AllowAnonymous]
public Task<IRemoteStreamContent> GetListAsCsvFileAsync(GetIdentityUserListAsFileInput input)
Parameters
Type Name Description
GetIdentityUserListAsFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetListAsExcelFileAsync(GetIdentityUserListAsFileInput)

Declaration
[HttpGet]
[Route("export-as-excel")]
[AllowAnonymous]
public Task<IRemoteStreamContent> GetListAsExcelFileAsync(GetIdentityUserListAsFileInput input)
Parameters
Type Name Description
GetIdentityUserListAsFileInput input
Returns
Type Description
Task<IRemoteStreamContent>

GetListAsync(GetIdentityUsersInput)

Declaration
[HttpGet]
public virtual Task<PagedResultDto<IdentityUserDto>> GetListAsync(GetIdentityUsersInput input)
Parameters
Type Name Description
GetIdentityUsersInput input
Returns
Type Description
Task<PagedResultDto<IdentityUserDto>>

GetOrganizationUnitLookupAsync()

Declaration
[HttpGet]
[Route("lookup/organization-units")]
public virtual Task<List<OrganizationUnitLookupDto>> GetOrganizationUnitLookupAsync()
Returns
Type Description
Task<List<OrganizationUnitLookupDto>>

GetOrganizationUnitsAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/organization-units")]
public virtual Task<List<OrganizationUnitDto>> GetOrganizationUnitsAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<List<OrganizationUnitDto>>

GetRoleLookupAsync()

Declaration
[HttpGet]
[Route("lookup/roles")]
public virtual Task<List<IdentityRoleLookupDto>> GetRoleLookupAsync()
Returns
Type Description
Task<List<IdentityRoleLookupDto>>

GetRolesAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/roles")]
public virtual Task<ListResultDto<IdentityRoleDto>> GetRolesAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<ListResultDto<IdentityRoleDto>>

GetTwoFactorEnabledAsync(Guid)

Declaration
[HttpGet]
[Route("{id}/two-factor-enabled")]
public Task<bool> GetTwoFactorEnabledAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task<bool>

ImportExternalUserAsync(ImportExternalUserInput)

Declaration
[HttpPost]
[Route("import-external-user")]
public Task<IdentityUserDto> ImportExternalUserAsync(ImportExternalUserInput input)
Parameters
Type Name Description
ImportExternalUserInput input
Returns
Type Description
Task<IdentityUserDto>

ImportUsersFromFileAsync(ImportUsersFromFileInputWithStream)

Declaration
[HttpPost]
[Route("import-users-from-file")]
public Task<ImportUsersFromFileOutput> ImportUsersFromFileAsync(ImportUsersFromFileInputWithStream input)
Parameters
Type Name Description
ImportUsersFromFileInputWithStream input
Returns
Type Description
Task<ImportUsersFromFileOutput>

LockAsync(Guid, DateTime)

Declaration
[HttpPut]
[Route("{id}/lock/{lockoutEnd}")]
public Task LockAsync(Guid id, DateTime lockoutEnd)
Parameters
Type Name Description
Guid id
DateTime lockoutEnd
Returns
Type Description
Task

SetTwoFactorEnabledAsync(Guid, bool)

Declaration
[HttpPut]
[Route("{id}/two-factor/{enabled}")]
public Task SetTwoFactorEnabledAsync(Guid id, bool enabled)
Parameters
Type Name Description
Guid id
bool enabled
Returns
Type Description
Task

UnlockAsync(Guid)

Declaration
[HttpPut]
[Route("{id}/unlock")]
public virtual Task UnlockAsync(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
Task

UpdateAsync(Guid, IdentityUserUpdateDto)

Declaration
[HttpPut]
[Route("{id}")]
public virtual Task<IdentityUserDto> UpdateAsync(Guid id, IdentityUserUpdateDto input)
Parameters
Type Name Description
Guid id
IdentityUserUpdateDto input
Returns
Type Description
Task<IdentityUserDto>

UpdateClaimsAsync(Guid, List<IdentityUserClaimDto>)

Declaration
[HttpPut]
[Route("{id}/claims")]
public virtual Task UpdateClaimsAsync(Guid id, List<IdentityUserClaimDto> input)
Parameters
Type Name Description
Guid id
List<IdentityUserClaimDto> input
Returns
Type Description
Task

UpdatePasswordAsync(Guid, IdentityUserUpdatePasswordInput)

Declaration
[HttpPut]
[Route("{id}/change-password")]
public virtual Task UpdatePasswordAsync(Guid id, IdentityUserUpdatePasswordInput input)
Parameters
Type Name Description
Guid id
IdentityUserUpdatePasswordInput input
Returns
Type Description
Task

UpdateRolesAsync(Guid, IdentityUserUpdateRolesDto)

Declaration
[HttpPut]
[Route("{id}/roles")]
public virtual Task UpdateRolesAsync(Guid id, IdentityUserUpdateRolesDto input)
Parameters
Type Name Description
Guid id
IdentityUserUpdateRolesDto input
Returns
Type Description
Task

Implements

IIdentityUserAppService
Volo.Abp.Application.Services.ICrudAppService<,,,,>
Volo.Abp.Application.Services.ICrudAppService<,,,,,>
Volo.Abp.Application.Services.IReadOnlyAppService<,,,>
Volo.Abp.Application.Services.IApplicationService
Volo.Abp.IRemoteService
Volo.Abp.Application.Services.ICreateUpdateAppService<,,,>
Volo.Abp.Application.Services.ICreateAppService<,>
Volo.Abp.Application.Services.IUpdateAppService<,,>
Volo.Abp.Application.Services.IDeleteAppService<>
In this article
Back to top Powered by Volosoft