Class: RBACApiClient::PrincipalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rbac-api-client/api/principal_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PrincipalApi

Returns a new instance of PrincipalApi.



19
20
21
 
# File 'lib/rbac-api-client/api/principal_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/rbac-api-client/api/principal_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_principals(opts = {}) ⇒ PrincipalPagination

List the principals for a tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned. (default to 10)

  • :offset (Integer) —

    Parameter for selecting the offset of data. (default to 0)

  • :usernames (String) —

    Usernames of principals to get

  • :sort_order (String) —

    The sort order of the query, either ascending or descending

Returns:



29
30
31
32
 
# File 'lib/rbac-api-client/api/principal_api.rb', line 29

def list_principals(opts = {})
  data, _status_code, _headers = list_principals_with_http_info(opts)
  data
end

#list_principals_with_http_info(opts = {}) ⇒ Array<(PrincipalPagination, Integer, Hash)>

List the principals for a tenant

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Parameter for selecting the amount of data returned.

  • :offset (Integer) —

    Parameter for selecting the offset of data.

  • :usernames (String) —

    Usernames of principals to get

  • :sort_order (String) —

    The sort order of the query, either ascending or descending

Returns:

  • (Array<(PrincipalPagination, Integer, Hash)>) —

    PrincipalPagination data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/rbac-api-client/api/principal_api.rb', line 41

def list_principals_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PrincipalApi.list_principals ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PrincipalApi.list_principals, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PrincipalApi.list_principals, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling PrincipalApi.list_principals, must be greater than or equal to 0.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/principals/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'usernames'] = opts[:'usernames'] if !opts[:'usernames'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PrincipalPagination' 

  # auth_names
  auth_names = opts[:auth_names] || ['basic_auth']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PrincipalApi#list_principals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end