Class: Harbor2Client::OidcApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OidcApi

Returns a new instance of OidcApi.



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

def api_client
  @api_client
end

Instance Method Details

#ping_oidc(endpoint, opts = {}) ⇒ nil

Test the OIDC endpoint. Test the OIDC endpoint, the setting of the endpoint is provided in the request. This API can only be called by system admin.

Parameters:

  • endpoint —

    Request body for OIDC endpoint to be tested.

  • 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/oidc_api.rb', line 28

def ping_oidc(endpoint, opts = {})
  ping_oidc_with_http_info(endpoint, opts)
  nil
end

#ping_oidc_with_http_info(endpoint, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test the OIDC endpoint. Test the OIDC endpoint, the setting of the endpoint is provided in the request. This API can only be called by system admin.

Parameters:

  • endpoint —

    Request body for OIDC endpoint to be tested.

  • 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/oidc_api.rb', line 39

def ping_oidc_with_http_info(endpoint, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OidcApi.ping_oidc ...'
  end
  # verify the required parameter 'endpoint' is set
  if @api_client.config.client_side_validation && endpoint.nil?
    fail ArgumentError, "Missing the required parameter 'endpoint' when calling OidcApi.ping_oidc"
  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 OidcApi.ping_oidc, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/system/oidc/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(endpoint)
  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: OidcApi#ping_oidc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end