Class: KatelloApi::Resources::Permission

Inherits:
Base
  • Object
show all
Defined in:
lib/katello_api/resources/permission.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from KatelloApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/katello_api/resources/permission.rb', line 4

def self.doc
  @doc ||= KatelloApi.doc['resources']["permissions"]
end

Instance Method Details

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • role_id (Object) —

    Part of /api/roles/:role_id/permissions path

  • permission (Hash) —

    allowed keys are:

    • organization_id [String]

    • all_tags [String] true if the permission should use all tags

    • all_verbs [String] true if the permission should use all verbs

    • description [String, nil]

    • name [String]

    • tags [Array] array of tag ids

    • type [String] name of a resource or ‘all’

    • verbs [Array] array of permission verbs

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



46
47
48
 
# File 'lib/katello_api/resources/permission.rb', line 46

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (Object) —

    Part of /api/roles/:role_id/permissions/:id path

  • role_id (Object) —

    Part of /api/roles/:role_id/permissions/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



56
57
58
 
# File 'lib/katello_api/resources/permission.rb', line 56

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • role_id (Object) —

    Part of /api/roles/:role_id/permissions path

  • all_tags (String) —

    filter by all_flags flag

  • all_verbs (String) —

    filter by all_verbs flag

  • description (String) —

    filter by description

  • name (String) —

    filter by name

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



17
18
19
 
# File 'lib/katello_api/resources/permission.rb', line 17

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (Object) —

    Part of /api/roles/:role_id/permissions/:id path

  • role_id (Object) —

    Part of /api/roles/:role_id/permissions/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



27
28
29
 
# File 'lib/katello_api/resources/permission.rb', line 27

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end