class Datacentred::Model::User

A user on your DataCentred account.

Users are team members with the ability to log into your DataCentred account.

All users created in your DataCented account are backed by a corresponding user in OpenStack's identity service (Keystone).

Public Class Methods

all() click to toggle source
List all available users.

 @raise [Errors::Unauthorized] Raised if credentials aren't valid.

@return [[User]] A collection of all users on this account.
# File lib/datacentred/model/user.rb, line 24
def all
  Request::Users.list.map {|user| new user }
end
create(params) click to toggle source
Create a new user.

@param [Hash] params User attributes.
@raise [Errors::UnprocessableEntity] Raised if validations fail for the supplied attributes.
@raise [Errors::Unauthorized] Raised if credentials aren't valid.

 @return [User] New user.

# File lib/datacentred/model/user.rb, line 16
def create(params)
  new Request::Users.create params
end
destroy(id) click to toggle source

Permanently remove the specified user.

@param [String] id The unique identifier for this user. @raise [Errors::NotFound] Raised if the user couldn't be found. @raise [Errors::UnprocessableEntity] Raised if validations fail for the specified user. @raise [Errors::Unauthorized] Raised if credentials aren't valid. @return [Boolean] Confirms the user was destroyed.

# File lib/datacentred/model/user.rb, line 57
def destroy(id)
  Request::Users.destroy id
  true
end
find(id) click to toggle source

Find a user by unique ID.

@param [String] id The unique identifier for this user. @raise [Errors::NotFound] Raised if the user couldn't be found. @raise [Errors::Unauthorized] Raised if credentials aren't valid. @return [User] The user, if it exists.

# File lib/datacentred/model/user.rb, line 34
def find(id)
  new Request::Users.show id
end
update(id, params) click to toggle source

Update a user by unique ID.

@param [String] id The unique identifier for this user. @param [Hash] params User attributes. @raise [Errors::UnprocessableEntity] Raised if validations fail for the supplied attributes. @raise [Errors::NotFound] Raised if the user couldn't be found. @raise [Errors::Unauthorized] Raised if credentials aren't valid. @return [User] The updated user.

# File lib/datacentred/model/user.rb, line 46
def update(id, params)
  new Request::Users.update id, params
end