Class: Harbor2Client::LdapApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/api/ldap_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LdapApi

Returns a new instance of LdapApi.



19
20
21
 
# File 'lib/harbor2_client/api/ldap_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/harbor2_client/api/ldap_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#import_ldap_user(uid_list, opts = {}) ⇒ nil

Import selected available ldap users. This endpoint adds the selected available ldap users to harbor based on related configuration parameters from the system. System will try to guess the user email address and realname, add to harbor user information. If have errors when import user, will return the list of importing failed uid and the failed reason.

Parameters:

  • uid_list —

    The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 28

def import_ldap_user(uid_list, opts = {})
  import_ldap_user_with_http_info(uid_list, opts)
  nil
end

#import_ldap_user_with_http_info(uid_list, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Import selected available ldap users. This endpoint adds the selected available ldap users to harbor based on related configuration parameters from the system. System will try to guess the user email address and realname, add to harbor user information. If have errors when import user, will return the list of importing failed uid and the failed reason.

Parameters:

  • uid_list —

    The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



39
40
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
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 39

def import_ldap_user_with_http_info(uid_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.import_ldap_user ...'
  end
  # verify the required parameter 'uid_list' is set
  if @api_client.config.client_side_validation && uid_list.nil?
    fail ArgumentError, "Missing the required parameter 'uid_list' when calling LdapApi.import_ldap_user"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling LdapApi.import_ldap_user, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/ldap/users/import'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(uid_list)
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#import_ldap_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ping_ldap(opts = {}) ⇒ LdapPingResult

Ping available ldap service. This endpoint ping the available ldap service for test related configuration parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :ldapconf (LdapConf) —

    ldap configuration. support input ldap service configuration. If it is a empty request, will load current configuration from the system.

Returns:



88
89
90
91
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 88

def ping_ldap(opts = {})
  data, _status_code, _headers = ping_ldap_with_http_info(opts)
  data
end

#ping_ldap_with_http_info(opts = {}) ⇒ Array<(LdapPingResult, Fixnum, Hash)>

Ping available ldap service. This endpoint ping the available ldap service for test related configuration parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :ldapconf (LdapConf) —

    ldap configuration. support input ldap service configuration. If it is a empty request, will load current configuration from the system.

Returns:

  • (Array<(LdapPingResult, Fixnum, Hash)>) —

    LdapPingResult data, response status code and response headers



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
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 99

def ping_ldap_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.ping_ldap ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling LdapApi.ping_ldap, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/ldap/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'ldapconf'])
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LdapPingResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#ping_ldap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_ldap_group(opts = {}) ⇒ Array<UserGroup>

Search available ldap groups. This endpoint searches the available ldap groups based on related configuration parameters. support to search by groupname or groupdn.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :groupname (String) —

    Ldap group name

  • :groupdn (String) —

    The LDAP group DN

Returns:



146
147
148
149
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 146

def search_ldap_group(opts = {})
  data, _status_code, _headers = search_ldap_group_with_http_info(opts)
  data
end

#search_ldap_group_with_http_info(opts = {}) ⇒ Array<(Array<UserGroup>, Fixnum, Hash)>

Search available ldap groups. This endpoint searches the available ldap groups based on related configuration parameters. support to search by groupname or groupdn.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :groupname (String) —

    Ldap group name

  • :groupdn (String) —

    The LDAP group DN

Returns:

  • (Array<(Array<UserGroup>, Fixnum, Hash)>) —

    Array<UserGroup> data, response status code and response headers



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 158

def search_ldap_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.search_ldap_group ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling LdapApi.search_ldap_group, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/ldap/groups/search'

  # query parameters
  query_params = {}
  query_params[:'groupname'] = opts[:'groupname'] if !opts[:'groupname'].nil?
  query_params[:'groupdn'] = opts[:'groupdn'] if !opts[:'groupdn'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<UserGroup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#search_ldap_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_ldap_user(opts = {}) ⇒ Array<LdapUser>

Search available ldap users. This endpoint searches the available ldap users based on related configuration parameters. Support searched by input ladp configuration, load configuration from the system and specific filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :username (String) —

    Registered user ID

Returns:



206
207
208
209
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 206

def search_ldap_user(opts = {})
  data, _status_code, _headers = search_ldap_user_with_http_info(opts)
  data
end

#search_ldap_user_with_http_info(opts = {}) ⇒ Array<(Array<LdapUser>, Fixnum, Hash)>

Search available ldap users. This endpoint searches the available ldap users based on related configuration parameters. Support searched by input ladp configuration, load configuration from the system and specific filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :username (String) —

    Registered user ID

Returns:

  • (Array<(Array<LdapUser>, Fixnum, Hash)>) —

    Array<LdapUser> data, response status code and response headers



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/harbor2_client/api/ldap_api.rb', line 217

def search_ldap_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.search_ldap_user ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling LdapApi.search_ldap_user, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/ldap/users/search'

  # query parameters
  query_params = {}
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<LdapUser>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#search_ldap_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end