Class UserManagerExtensions

Inheritance

object

UserManagerExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Management.Users

Assembly: Couchbase.NetClient.dll

Syntax

public static class UserManagerExtensions

Methods

View Source

AvailableRolesAsync(IUserManager)

Declaration

public static Task<IEnumerable<RoleAndDescription>> AvailableRolesAsync(this IUserManager userManager)

Parameters

Type	Name	Description
IUserManager	userManager

Returns

Type	Description
Task<IEnumerable<RoleAndDescription>>

View Source

AvailableRolesAsync(IUserManager, Action<AvailableRolesOptions>)

Declaration

public static Task<IEnumerable<RoleAndDescription>> AvailableRolesAsync(this IUserManager userManager, Action<AvailableRolesOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
Action<AvailableRolesOptions>	configureOptions

Returns

Type	Description
Task<IEnumerable<RoleAndDescription>>

View Source

ChangeUserPasswordAsync(IUserManager, string)

Declaration

public static Task ChangeUserPasswordAsync(this IUserManager userManager, string password)

Parameters

Type	Name	Description
IUserManager	userManager
string	password

Returns

Type	Description
Task

View Source

ChangeUserPasswordAsync(IUserManager, string, Action<ChangePasswordOptions>)

Declaration

public static Task ChangeUserPasswordAsync(this IUserManager userManager, string password, Action<ChangePasswordOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
string	password
Action<ChangePasswordOptions>	configureOptions

Returns

Type	Description
Task

View Source

DropGroupAsync(IUserManager, string)

Declaration

public static Task DropGroupAsync(this IUserManager userManager, string groupName)

Parameters

Type	Name	Description
IUserManager	userManager
string	groupName

Returns

Type	Description
Task

View Source

DropGroupAsync(IUserManager, string, Action<DropGroupOptions>)

Declaration

public static Task DropGroupAsync(this IUserManager userManager, string groupName, Action<DropGroupOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
string	groupName
Action<DropGroupOptions>	configureOptions

Returns

Type	Description
Task

View Source

DropUserAsync(IUserManager, string)

Declaration

public static Task DropUserAsync(this IUserManager userManager, string username)

Parameters

Type	Name	Description
IUserManager	userManager
string	username

Returns

Type	Description
Task

View Source

DropUserAsync(IUserManager, string, Action<DropUserOptions>)

Declaration

public static Task DropUserAsync(this IUserManager userManager, string username, Action<DropUserOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
string	username
Action<DropUserOptions>	configureOptions

Returns

Type	Description
Task

View Source

GetAllGroupsAsync(IUserManager)

Declaration

public static Task<IEnumerable<Group>> GetAllGroupsAsync(this IUserManager userManager)

Parameters

Type	Name	Description
IUserManager	userManager

Returns

Type	Description
Task<IEnumerable<Group>>

View Source

GetAllGroupsAsync(IUserManager, Action<GetAllGroupsOptions>)

Declaration

public static Task<IEnumerable<Group>> GetAllGroupsAsync(this IUserManager userManager, Action<GetAllGroupsOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
Action<GetAllGroupsOptions>	configureOptions

Returns

Type	Description
Task<IEnumerable<Group>>

View Source

GetAllUsersAsync(IUserManager)

Declaration

public static Task<IEnumerable<UserAndMetaData>> GetAllUsersAsync(this IUserManager userManager)

Parameters

Type	Name	Description
IUserManager	userManager

Returns

Type	Description
Task<IEnumerable<UserAndMetaData>>

View Source

GetAllUsersAsync(IUserManager, Action<GetAllUsersOptions>)

Declaration

public static Task<IEnumerable<UserAndMetaData>> GetAllUsersAsync(this IUserManager userManager, Action<GetAllUsersOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
Action<GetAllUsersOptions>	configureOptions

Returns

Type	Description
Task<IEnumerable<UserAndMetaData>>

View Source

GetGroupAsync(IUserManager, string)

Declaration

public static Task<Group> GetGroupAsync(this IUserManager userManager, string groupName)

Parameters

Type	Name	Description
IUserManager	userManager
string	groupName

Returns

Type	Description
Task<Group>

View Source

GetGroupAsync(IUserManager, string, Action<GetGroupOptions>)

Declaration

public static Task<Group> GetGroupAsync(this IUserManager userManager, string groupName, Action<GetGroupOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
string	groupName
Action<GetGroupOptions>	configureOptions

Returns

Type	Description
Task<Group>

View Source

GetUserAsync(IUserManager, string)

Declaration

public static Task<UserAndMetaData> GetUserAsync(this IUserManager userManager, string username)

Parameters

Type	Name	Description
IUserManager	userManager
string	username

Returns

Type	Description
Task<UserAndMetaData>

View Source

GetUserAsync(IUserManager, string, Action<GetUserOptions>)

Declaration

public static Task<UserAndMetaData> GetUserAsync(this IUserManager userManager, string username, Action<GetUserOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
string	username
Action<GetUserOptions>	configureOptions

Returns

Type	Description
Task<UserAndMetaData>

View Source

UpsertGroupAsync(IUserManager, Group)

Declaration

public static Task UpsertGroupAsync(this IUserManager userManager, Group group)

Parameters

Type	Name	Description
IUserManager	userManager
Group	group

Returns

Type	Description
Task

View Source

UpsertGroupAsync(IUserManager, Group, Action<UpsertGroupOptions>)

Declaration

public static Task UpsertGroupAsync(this IUserManager userManager, Group group, Action<UpsertGroupOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
Group	group
Action<UpsertGroupOptions>	configureOptions

Returns

Type	Description
Task

View Source

UpsertUsersAsync(IUserManager, User)

Declaration

public static Task UpsertUsersAsync(this IUserManager userManager, User user)

Parameters

Type	Name	Description
IUserManager	userManager
User	user

Returns

Type	Description
Task

View Source

UpsertUsersAsync(IUserManager, User, Action<UpsertUserOptions>)

Declaration

public static Task UpsertUsersAsync(this IUserManager userManager, User user, Action<UpsertUserOptions> configureOptions)

Parameters

Type	Name	Description
IUserManager	userManager
User	user
Action<UpsertUserOptions>	configureOptions

Returns

Type	Description
Task