Class: Passbase::IdentityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/passbase/api/identity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityApi

Returns a new instance of IdentityApi.



19
20
21
 
# File 'lib/passbase/api/identity_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/passbase/api/identity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_identity_by_id(id, opts = {}) ⇒ Identity

Get identity Retrieve an identity by providing the identity ID.

Parameters:

  • id (String) —

    Unique ID of the identity to return

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/passbase/api/identity_api.rb', line 27

def get_identity_by_id(id, opts = {})
  data, _status_code, _headers = get_identity_by_id_with_http_info(id, opts)
  data
end

#get_identity_by_id_with_http_info(id, opts = {}) ⇒ Array<(Identity, Integer, Hash)>

Get identity Retrieve an identity by providing the identity ID.

Parameters:

  • id (String) —

    Unique ID of the identity to return

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

    the optional parameters

Returns:

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

    Identity data, response status code and response headers



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
 
# File 'lib/passbase/api/identity_api.rb', line 37

def get_identity_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.get_identity_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity_by_id"
  end
  # resource path
  local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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'])

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

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

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

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

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

#get_identity_resource_by_id(id, resource_id, opts = {}) ⇒ Resource

Get resource Get a resource attached to an identity by providing the resource ID.

Parameters:

  • id (String) —

    Identity id

  • resource_id (String) —

    Resource id

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/passbase/api/identity_api.rb', line 91

def get_identity_resource_by_id(id, resource_id, opts = {})
  data, _status_code, _headers = get_identity_resource_by_id_with_http_info(id, resource_id, opts)
  data
end

#get_identity_resource_by_id_with_http_info(id, resource_id, opts = {}) ⇒ Array<(Resource, Integer, Hash)>

Get resource Get a resource attached to an identity by providing the resource ID.

Parameters:

  • id (String) —

    Identity id

  • resource_id (String) —

    Resource id

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

    the optional parameters

Returns:

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

    Resource data, response status code and response headers



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
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/passbase/api/identity_api.rb', line 102

def get_identity_resource_by_id_with_http_info(id, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.get_identity_resource_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity_resource_by_id"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling IdentityApi.get_identity_resource_by_id"
  end
  # resource path
  local_var_path = '/identity/{id}/resources/{resource_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s))

  # 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'])

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

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

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

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

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

#get_identity_resource_file_by_id(id, resource_id, resource_file_id, opts = {}) ⇒ ResourceFile

Get resource file Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you’ll need a specific government authorization to access it.

Parameters:

  • id (String) —

    Identity id

  • resource_id (String) —

    Resource id

  • resource_file_id (String) —

    Resource file id

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

    the optional parameters

Returns:



161
162
163
164
 
# File 'lib/passbase/api/identity_api.rb', line 161

def get_identity_resource_file_by_id(id, resource_id, resource_file_id, opts = {})
  data, _status_code, _headers = get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id, opts)
  data
end

#get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id, opts = {}) ⇒ Array<(ResourceFile, Integer, Hash)>

Get resource file Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you&#39;ll need a specific government authorization to access it.

Parameters:

  • id (String) —

    Identity id

  • resource_id (String) —

    Resource id

  • resource_file_id (String) —

    Resource file id

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

    the optional parameters

Returns:

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

    ResourceFile data, response status code and response headers



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/passbase/api/identity_api.rb', line 173

def get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.get_identity_resource_file_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity_resource_file_by_id"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling IdentityApi.get_identity_resource_file_by_id"
  end
  # verify the required parameter 'resource_file_id' is set
  if @api_client.config.client_side_validation && resource_file_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_file_id' when calling IdentityApi.get_identity_resource_file_by_id"
  end
  # resource path
  local_var_path = '/identity/{id}/resources/{resource_id}/resource_files/{resource_file_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)).sub('{' + 'resource_file_id' + '}', CGI.escape(resource_file_id.to_s))

  # 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'])

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

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

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

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

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

#list_identities(opts = {}) ⇒ PaginatedIdentities

List identities List all the identities retrievable by the provided API Secret Key.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :cursor (String)

Returns:



235
236
237
238
 
# File 'lib/passbase/api/identity_api.rb', line 235

def list_identities(opts = {})
  data, _status_code, _headers = list_identities_with_http_info(opts)
  data
end

#list_identities_with_http_info(opts = {}) ⇒ Array<(PaginatedIdentities, Integer, Hash)>

List identities List all the identities retrievable by the provided API Secret Key.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :cursor (String)

Returns:

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

    PaginatedIdentities data, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/passbase/api/identity_api.rb', line 246

def list_identities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.list_identities ...'
  end
  # resource path
  local_var_path = '/identities'

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

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

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

#list_identity_resources(id, opts = {}) ⇒ PaginatedResources

List resources List resources attached to an identity by providing the identity ID.

Parameters:

  • id (String) —

    Identity id

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :cursor (String)

Returns:



299
300
301
302
 
# File 'lib/passbase/api/identity_api.rb', line 299

def list_identity_resources(id, opts = {})
  data, _status_code, _headers = list_identity_resources_with_http_info(id, opts)
  data
end

#list_identity_resources_with_http_info(id, opts = {}) ⇒ Array<(PaginatedResources, Integer, Hash)>

List resources List resources attached to an identity by providing the identity ID.

Parameters:

  • id (String) —

    Identity id

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer)
  • :cursor (String)

Returns:

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

    PaginatedResources data, response status code and response headers



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/passbase/api/identity_api.rb', line 311

def list_identity_resources_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.list_identity_resources ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.list_identity_resources"
  end
  # resource path
  local_var_path = '/identity/{id}/resources'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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