Module: Code42::API::Role

Included in:

Client

Defined in:

lib/code42/api/role.rb

Instance Method Summary

• #assign_role(attrs = {}) ⇒ Code42::Role

  Assigns a role to a user.

• #user_roles(id = 'my') ⇒ Code42::RoleCollection

  Returns a list of roles for a given user.

Instance Method Details

#assign_role(attrs = {}) ⇒ Code42::Role

Assigns a role to a user

Examples:

client.assign_role(:user_id => 2, :role_name => 'Admin')

Parameters:

• attrs (Hash) (defaults to: {}) —

  A hash of attributes for assigning a user role

Returns:

• (Code42::Role) —

  The assigned role

# File 'lib/code42/api/role.rb', line 11

def assign_role(attrs = {})
  object_from_response(Code42::Role, :post, 'UserRole', attrs)
end

#user_roles(id = 'my') ⇒ Code42::RoleCollection

Returns a list of roles for a given user

Parameters:

• id (String, Integer) (defaults to: 'my') —

  The id of the user to return roles for

Returns:

• (Code42::RoleCollection) —

  A collection of matching roles

# File 'lib/code42/api/role.rb', line 18

def user_roles(id = 'my')
  collection_from_response(Code42::RoleCollection, Code42::Role, :get, "userRole/#{id}")
end