Class: RBACApiClient::PrincipalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/insights-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/insights-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/insights-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 By default, responses are sorted in ascending order by username

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)

  • :match_criteria (String) —

    Parameter for specifying the matching criteria for an object's name and/or email. Currently, match_criteria of partial searches for a username/email using "starts with" pattern. (default to ‘exact’)

  • :usernames (String) —

    Comma separated usernames of principals to get. If match_criteria is specified, only the first username will be picked up for search.

  • :sort_order (String) —

    The sort order of the query, either ascending or descending. Defaults to ascending.

  • :email (String) —

    E-mail address of principal to search for. Could be combined with match_criteria for searching.

  • :status (String) —

    Set the status of users to get back. (default to ‘enabled’)

  • :admin_only (String) —

    Get only admin users within an account. Setting this would ignore the parameters: usernames, email (default to ‘false’)

  • :order_by (String) —

    Parameter for ordering principals by value. For inverse ordering, supply '-' before the param value, such as: ?order_by=-username

  • :username_only (Boolean) —

    Parameter for optionally returning only usernames for principals, bypassing a call to IT.

Returns:



36
37
38
39
 
# File 'lib/insights-rbac-api-client/api/principal_api.rb', line 36

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 By default, responses are sorted in ascending order by username

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)

  • :match_criteria (String) —

    Parameter for specifying the matching criteria for an object&#39;s name and/or email. Currently, match_criteria of partial searches for a username/email using &quot;starts with&quot; pattern. (default to ‘exact’)

  • :usernames (String) —

    Comma separated usernames of principals to get. If match_criteria is specified, only the first username will be picked up for search.

  • :sort_order (String) —

    The sort order of the query, either ascending or descending. Defaults to ascending.

  • :email (String) —

    E-mail address of principal to search for. Could be combined with match_criteria for searching.

  • :status (String) —

    Set the status of users to get back. (default to ‘enabled’)

  • :admin_only (String) —

    Get only admin users within an account. Setting this would ignore the parameters: usernames, email (default to ‘false’)

  • :order_by (String) —

    Parameter for ordering principals by value. For inverse ordering, supply &#39;-&#39; before the param value, such as: ?order_by&#x3D;-username

  • :username_only (Boolean) —

    Parameter for optionally returning only usernames for principals, bypassing a call to IT.

Returns:

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

    PrincipalPagination data, response status code and response headers



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/insights-rbac-api-client/api/principal_api.rb', line 55

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 = ["partial", "exact"]
  if @api_client.config.client_side_validation && opts[:'match_criteria'] && !allowable_values.include?(opts[:'match_criteria'])
    fail ArgumentError, "invalid value for \"match_criteria\", must be one of #{allowable_values}"
  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
  allowable_values = ["enabled", "disabled", "all"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'admin_only'] && !allowable_values.include?(opts[:'admin_only'])
    fail ArgumentError, "invalid value for \"admin_only\", must be one of #{allowable_values}"
  end
  allowable_values = ["username"]
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
    fail ArgumentError, "invalid value for \"order_by\", 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[:'match_criteria'] = opts[:'match_criteria'] if !opts[:'match_criteria'].nil?
  query_params[:'usernames'] = opts[:'usernames'] if !opts[:'usernames'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'admin_only'] = opts[:'admin_only'] if !opts[:'admin_only'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'username_only'] = opts[:'username_only'] if !opts[:'username_only'].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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"PrincipalApi.list_principals",
    :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