Interface IUserManager

Namespace: Couchbase.Management.Users
Assembly: Couchbase.NetClient.dll
Syntax
public interface IUserManager

Methods

View Source

ChangeUserPasswordAsync(string, ChangePasswordOptions?)

Declaration
Task ChangeUserPasswordAsync(string password, ChangePasswordOptions? options = null)
Parameters
Type Name Description
string password
ChangePasswordOptions options
Returns
Type Description
Task
View Source

DropGroupAsync(string, DropGroupOptions?)

Declaration
Task DropGroupAsync(string groupName, DropGroupOptions? options = null)
Parameters
Type Name Description
string groupName
DropGroupOptions options
Returns
Type Description
Task
View Source

DropUserAsync(string, DropUserOptions?)

Declaration
Task DropUserAsync(string username, DropUserOptions? options = null)
Parameters
Type Name Description
string username
DropUserOptions options
Returns
Type Description
Task
View Source

GetAllGroupsAsync(GetAllGroupsOptions?)

Declaration
Task<IEnumerable<Group>> GetAllGroupsAsync(GetAllGroupsOptions? options = null)
Parameters
Type Name Description
GetAllGroupsOptions options
Returns
Type Description
Task<IEnumerable<Group>>
View Source

GetAllUsersAsync(GetAllUsersOptions?)

Declaration
Task<IEnumerable<UserAndMetaData>> GetAllUsersAsync(GetAllUsersOptions? options = null)
Parameters
Type Name Description
GetAllUsersOptions options
Returns
Type Description
Task<IEnumerable<UserAndMetaData>>
View Source

GetGroupAsync(string, GetGroupOptions?)

Declaration
Task<Group> GetGroupAsync(string groupName, GetGroupOptions? options = null)
Parameters
Type Name Description
string groupName
GetGroupOptions options
Returns
Type Description
Task<Group>
View Source

GetRolesAsync(AvailableRolesOptions?)

Declaration
Task<IEnumerable<RoleAndDescription>> GetRolesAsync(AvailableRolesOptions? options = null)
Parameters
Type Name Description
AvailableRolesOptions options
Returns
Type Description
Task<IEnumerable<RoleAndDescription>>
View Source

GetUserAsync(string, GetUserOptions?)

Declaration
Task<UserAndMetaData> GetUserAsync(string username, GetUserOptions? options = null)
Parameters
Type Name Description
string username
GetUserOptions options
Returns
Type Description
Task<UserAndMetaData>
View Source

UpsertGroupAsync(Group, UpsertGroupOptions?)

Declaration
Task UpsertGroupAsync(Group group, UpsertGroupOptions? options = null)
Parameters
Type Name Description
Group group
UpsertGroupOptions options
Returns
Type Description
Task
View Source

UpsertUserAsync(User, UpsertUserOptions?)

Declaration
Task UpsertUserAsync(User user, UpsertUserOptions? options = null)
Parameters
Type Name Description
User user
UpsertUserOptions options
Returns
Type Description
Task

Extension Methods