cyberark/conjur-api-ruby

#
# Copyright 2013-2018 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
  class API
    
    # Retrieve the policy for the given LDAP sync
    # configuration. Configurations created through the Conjur UI are
    # named +default+, so the default value of +config_name+ can be
    # used.
    #
    # For details on the use of LDAP sync, see
    # https://developer.conjur.net/reference/services/ldap_sync/ .
    #
    # @param [String] config_name the name of the LDAP sync configuration.
    def ldap_sync_policy config_name: 'default'
      JSON.parse(url_for(:ldap_sync_policy, credentials, config_name).get)
    end
  end
end