cyberark/conjur-api-ruby

View on GitHub
lib/conjur/policy.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
#
# 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

  # Defines an set of objects, permission grants and role grants. All objects in a policy
  # share a common naming prefix, which is the id of the policy. (Exception: the root
  # policy does not add a naming prefix to each of its objects).
  #
  # Policies are defined using a YAML syntax, which is extensively documented on the Conjur 
  # web site. To load a policy, define it using YAML and then use {API#load_policy}.
  #
  # @see API#load_policy
  class Policy < BaseObject
    include ActsAsRolsource
  end
end