ignivault.ApiClient.Admin.AdminApiClient Class Reference

Inheritance diagram for ignivault.ApiClient.Admin.AdminApiClient:

Collaboration diagram for ignivault.ApiClient.Admin.AdminApiClient:

Public Member Functions
	AdminApiClient (HttpClient httpClient)
async Task< ApiResponse< IEnumerable< UserDto > > >	GetUsersAsync ()
	Gets a list of all users.
async Task< ApiResponse >	LockUserAsync (string userId)
	Locks a user account, preventing them from logging in.
async Task< ApiResponse >	UnlockUserAsync (string userId)
	Unlocks a user account, allowing them to log in again.
async Task< ApiResponse< IEnumerable< string > > >	GetRolesAsync ()
	Gets a list of all available roles.
async Task< ApiResponse< IEnumerable< string > > >	GetUserRolesAsync (string userId)
	Gets the roles assigned to a specific user.
async Task< ApiResponse >	AddRoleToUserAsync (string userId, string roleName)
	Adds a role to a specific user.
async Task< ApiResponse >	RemoveRoleFromUserAsync (string userId, string roleName)
	Removes a role from a specific user.

Detailed Description

Definition at line 62 of file AdminApiClient.cs.

Constructor & Destructor Documentation

AdminApiClient()

ignivault.ApiClient.Admin.AdminApiClient.AdminApiClient ( HttpClient httpClient )

inline

Definition at line 65 of file AdminApiClient.cs.

Member Function Documentation

AddRoleToUserAsync()

async Task< ApiResponse > ignivault.ApiClient.Admin.AdminApiClient.AddRoleToUserAsync ( string userId, string roleName )

inline

Adds a role to a specific user.

Parameters

userId
roleName

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 103 of file AdminApiClient.cs.

GetRolesAsync()

async Task< ApiResponse< IEnumerable< string > > > ignivault.ApiClient.Admin.AdminApiClient.GetRolesAsync ( )

inline

Gets a list of all available roles.

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 87 of file AdminApiClient.cs.

GetUserRolesAsync()

async Task< ApiResponse< IEnumerable< string > > > ignivault.ApiClient.Admin.AdminApiClient.GetUserRolesAsync ( string userId )

inline

Gets the roles assigned to a specific user.

Parameters

userId

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 95 of file AdminApiClient.cs.

GetUsersAsync()

async Task< ApiResponse< IEnumerable< UserDto > > > ignivault.ApiClient.Admin.AdminApiClient.GetUsersAsync ( )

inline

Gets a list of all users.

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 67 of file AdminApiClient.cs.

LockUserAsync()

async Task< ApiResponse > ignivault.ApiClient.Admin.AdminApiClient.LockUserAsync ( string userId )

inline

Locks a user account, preventing them from logging in.

Parameters

userId

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 73 of file AdminApiClient.cs.

RemoveRoleFromUserAsync()

async Task< ApiResponse > ignivault.ApiClient.Admin.AdminApiClient.RemoveRoleFromUserAsync ( string userId, string roleName )

inline

Removes a role from a specific user.

Parameters

userId
roleName

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 110 of file AdminApiClient.cs.

UnlockUserAsync()

async Task< ApiResponse > ignivault.ApiClient.Admin.AdminApiClient.UnlockUserAsync ( string userId )

inline

Unlocks a user account, allowing them to log in again.

Parameters

userId

Returns

Implements ignivault.ApiClient.Admin.IAdminApiClient.

Definition at line 80 of file AdminApiClient.cs.

---

The documentation for this class was generated from the following file:

• C:/Users/prest/Desktop/GitHub/Ignivault/ignivault.ApiClient/Admin/AdminApiClient.cs