Class: CybridApiId::OrganizationApplicationsIdpApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationApplicationsIdpApi

Returns a new instance of OrganizationApplicationsIdpApi.



19
20
21
 
# File 'lib/cybrid_api_id_ruby/api/organization_applications_idp_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/cybrid_api_id_ruby/api/organization_applications_idp_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_organization_application(post_organization_application_idp_model, opts = {}) ⇒ ApplicationWithSecretIdpModel

Create organization application Create an organization OAuth2 application. Required scope: organization_applications:execute

Parameters:

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb', line 27

def create_organization_application(post_organization_application_idp_model, opts = {})
  data, _status_code, _headers = create_organization_application_with_http_info(post_organization_application_idp_model, opts)
  data
end

#create_organization_application_with_http_info(post_organization_application_idp_model, opts = {}) ⇒ Array<(ApplicationWithSecretIdpModel, Integer, Hash)>

Create organization application Create an organization OAuth2 application. Required scope: organization_applications:execute

Parameters:

Returns:



37
38
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
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb', line 37

def create_organization_application_with_http_info(post_organization_application_idp_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApplicationsIdpApi.create_organization_application ...'
  end
  # verify the required parameter 'post_organization_application_idp_model' is set
  if @api_client.config.client_side_validation && post_organization_application_idp_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_organization_application_idp_model' when calling OrganizationApplicationsIdpApi.create_organization_application"
  end
  # resource path
  local_var_path = '/api/organization_applications'

  # query parameters
  query_params = opts[:query_params] || {}

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

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_organization_application_idp_model)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"OrganizationApplicationsIdpApi.create_organization_application",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationApplicationsIdpApi#create_organization_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_organization_applications(opts = {}) ⇒ ApplicationListIdpModel

List organization applications Retrieve a list of organization OAuth2 applications. Required scope: organizations:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

Returns:



96
97
98
99
 
# File 'lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb', line 96

def list_organization_applications(opts = {})
  data, _status_code, _headers = list_organization_applications_with_http_info(opts)
  data
end

#list_organization_applications_with_http_info(opts = {}) ⇒ Array<(ApplicationListIdpModel, Integer, Hash)>

List organization applications Retrieve a list of organization OAuth2 applications. Required scope: organizations:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

Returns:

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

    ApplicationListIdpModel data, response status code and response headers



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb', line 107

def list_organization_applications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationApplicationsIdpApi.list_organization_applications ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling OrganizationApplicationsIdpApi.list_organization_applications, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling OrganizationApplicationsIdpApi.list_organization_applications, must be smaller than or equal to 100.'
  end

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

  # resource path
  local_var_path = '/api/organization_applications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'ApplicationListIdpModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"OrganizationApplicationsIdpApi.list_organization_applications",
    :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: OrganizationApplicationsIdpApi#list_organization_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end