cyberark/conjur-api-ruby

# Copyright 2013-2017 Conjur Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
module Conjur

  # A Conjur Group represents a collection of Conjur Users, Groups and Layers.
  #
  class Group < BaseObject
    include ActsAsRolsource

    # Get the group's gidnumber, which can be used by LDAP and SSH login, among other things.
    #
    # @return [Fixnum] the gidnumber
    # @raise [RestClient::Forbidden] if you don't have permission to `show` the group.
    def gidnumber
      parser_for(:group_gidnumber, group_attributes)
    end

    private

    def group_attributes
      @group_attributes ||= url_for(:group_attributes, credentials, self, id)
    end
  end
end