Class: Couchbase::Management::UserManager

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/user_manager.rb

Defined Under Namespace

Classes: DropGroupOptions, DropUserOptions, GetAllGroupsOptions, GetAllUsersOptions, GetGroupOptions, GetRolesOptions, GetUserOptions, UpsertGroupOptions, UpsertUserOptions

Instance Method Summary collapse

Constructor Details

#initialize(backend) ⇒ UserManager

Returns a new instance of UserManager.

Parameters:

  • backend (Couchbase::Backend)
[View source]

23
24
25
 
# File 'lib/couchbase/management/user_manager.rb', line 23

def initialize(backend)
  @backend = backend
end

Instance Method Details

#drop_group(group_name, options = DropGroupOptions.new) ⇒ Object

Removes a group

Parameters:

  • group_name (String) —

    name of the group

  • options (DropGroupOptions) (defaults to: DropGroupOptions.new)

Raises:

[View source]

112
 
# File 'lib/couchbase/management/user_manager.rb', line 112

def drop_group(group_name, options = DropGroupOptions.new) end

#drop_user(user_name, options = DropUserOptions.new) ⇒ Object

Removes a user

Parameters:

  • user_name (String) —

    ID of the user

  • options (DropUserOptions) (defaults to: DropUserOptions.new)
[View source]

61
62
63
 
# File 'lib/couchbase/management/user_manager.rb', line 61

def drop_user(user_name, options = DropUserOptions.new)
  # DELETE /settings/rbac/users/#{options.domain}/#{user_name}
end

#get_all_groups(options = GetAllGroupsOptions.new) ⇒ Array<Group>

Gets all groups

Parameters:

Returns:

[View source]

91
92
93
 
# File 'lib/couchbase/management/user_manager.rb', line 91

def get_all_groups(options = GetAllGroupsOptions.new)
  # GET /settings/rbac/groups
end

#get_all_users(options = GetAllUsersOptions.new) ⇒ Array<UserAndMetadata>

Gets all users

Returns:

[View source]

43
44
45
 
# File 'lib/couchbase/management/user_manager.rb', line 43

def get_all_users(options = GetAllUsersOptions.new)
  # GET /settings/rbac/users/#{options.domain}
end

#get_group(group_name, options = GetGroupOptions.new) ⇒ Group

Gets a group

Parameters:

  • group_name (String) —

    name of the group to get

Returns:

Raises:

[View source]

82
83
84
 
# File 'lib/couchbase/management/user_manager.rb', line 82

def get_group(group_name, options = GetGroupOptions.new)
  # GET /settings/rbac/groups/#{group_name}
end

#get_roles(options = GetRolesOptions.new) ⇒ Array<RoleAndDescription>

Gets all roles supported by the server

Parameters:

Returns:

[View source]

70
71
72
 
# File 'lib/couchbase/management/user_manager.rb', line 70

def get_roles(options = GetRolesOptions.new)
  # GET /settings/rbac/roles
end

#get_user(user_name, options = GetUserOptions.new) ⇒ UserAndMetadata

Get a user

Parameters:

  • user_name (String) —

    ID of the user

  • options (GetUserOptions) (defaults to: GetUserOptions.new)

Returns:

Raises:

[View source]

36
37
38
 
# File 'lib/couchbase/management/user_manager.rb', line 36

def get_user(user_name, options = GetUserOptions.new)
  # GET /settings/rbac/users/#{options.domain}/#{user_name}
end

#upsert_group(group, options = UpsertGroupOptions.new) ⇒ Object

Creates or updates a group

Parameters:

  • group (Group) —

    the new version of the group

  • options (UpsertGroupOptions) (defaults to: UpsertGroupOptions.new)

Raises:

[View source]

102
103
104
 
# File 'lib/couchbase/management/user_manager.rb', line 102

def upsert_group(group, options = UpsertGroupOptions.new)
  # PUT /settings/rbac/groups/#{group.name}
end

#upsert_user(user, options = UpsertUserOptions.new) ⇒ Object

Creates or updates a user

Parameters:

  • user (User) —

    the new version of the user

  • options (UpsertUserOptions) (defaults to: UpsertUserOptions.new)

Raises:

  • (ArgumentError)
[View source]

53
54
55
 
# File 'lib/couchbase/management/user_manager.rb', line 53

def upsert_user(user, options = UpsertUserOptions.new)
  # PUT /settings/rbac/users/#{options.domain}/#{user_name}
end