Class: SubskribeSandboxClient::AuthenticationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/authentication_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthenticationApi

Returns a new instance of AuthenticationApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/authentication_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/subskribe_sandbox/api/authentication_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_saml_integration(opts = {}) ⇒ nil

Add a saml integration Adds a saml integration

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 27

def add_saml_integration(opts = {})
  add_saml_integration_with_http_info(opts)
  nil
end

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

Add a saml integration Adds a saml integration

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, 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
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 37

def add_saml_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.add_saml_integration ...'
  end
  # resource path
  local_var_path = '/auth/saml'

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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: AuthenticationApi#add_saml_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_api_key(opts = {}) ⇒ String

Create a new api key Create a new api key with the specified parameters. The new key is returned

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :role (String) —

    Role-based permissions to be associated with the key. Specify this OR userId.

  • :expiry (Integer) —

    Time of expiry in seconds since Epoch (GMT)

  • :user_id (String) —

    User to associate key with. Specify this OR role.

  • :entity_id (String) —

    Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).

Returns:

  • (String) 


79
80
81
82
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 79

def create_api_key(opts = {})
  data, _status_code, _headers = create_api_key_with_http_info(opts)
  data
end

#create_api_key_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create a new api key Create a new api key with the specified parameters. The new key is returned

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :role (String) —

    Role-based permissions to be associated with the key. Specify this OR userId.

  • :expiry (Integer) —

    Time of expiry in seconds since Epoch (GMT)

  • :user_id (String) —

    User to associate key with. Specify this OR role.

  • :entity_id (String) —

    Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 92

def create_api_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.create_api_key ...'
  end
  if @api_client.config.client_side_validation && opts[:'role'] && !['ADMIN', 'FINANCE', 'SALES', 'DEAL_DESK', 'BILLING_CLERK', 'REVENUE_CLERK', 'READ_ONLY', 'EXECUTIVE', 'CRM', 'IMPORT'].include?(opts[:'role'])
    fail ArgumentError, 'invalid value for "role", must be one of ADMIN, FINANCE, SALES, DEAL_DESK, BILLING_CLERK, REVENUE_CLERK, READ_ONLY, EXECUTIVE, CRM, IMPORT'
  end
  # resource path
  local_var_path = '/apikey'

  # query parameters
  query_params = {}
  query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
  query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_api_keys(opts = {}) ⇒ nil

Retrieves all API keys Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


138
139
140
141
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 138

def get_all_api_keys(opts = {})
  get_all_api_keys_with_http_info(opts)
  nil
end

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

Retrieves all API keys Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 147

def get_all_api_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_all_api_keys ...'
  end
  # resource path
  local_var_path = '/apikey'

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationApi#get_all_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_api_key_by_id(id, opts = {}) ⇒ nil

Retrieve an API key by id Retrieve an api key referenced by its id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 186

def get_api_key_by_id(id, opts = {})
  get_api_key_by_id_with_http_info(id, opts)
  nil
end

#get_api_key_by_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Retrieve an API key by id Retrieve an api key referenced by its id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
228
229
230
231
232
233
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 196

def get_api_key_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_api_key_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 AuthenticationApi.get_api_key_by_id"
  end
  # resource path
  local_var_path = '/apikey/{id}'.sub('{' + 'id' + '}', id.to_s)

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationApi#get_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_api_key(opts = {}) ⇒ nil

revoke all keys Revokes all keys for your tenant

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


238
239
240
241
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 238

def revoke_api_key(opts = {})
  revoke_api_key_with_http_info(opts)
  nil
end

#revoke_api_key_by_id(id, opts = {}) ⇒ nil

revoke an API key by id Revoke an api key referenced by its id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


286
287
288
289
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 286

def revoke_api_key_by_id(id, opts = {})
  revoke_api_key_by_id_with_http_info(id, opts)
  nil
end

#revoke_api_key_by_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

revoke an API key by id Revoke an api key referenced by its id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 296

def revoke_api_key_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key_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 AuthenticationApi.revoke_api_key_by_id"
  end
  # resource path
  local_var_path = '/apikey/revoke/{id}'.sub('{' + 'id' + '}', id.to_s)

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: AuthenticationApi#revoke_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

revoke all keys Revokes all keys for your tenant

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/authentication_api.rb', line 247

def revoke_api_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key ...'
  end
  # resource path
  local_var_path = '/apikey/revoke'

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: AuthenticationApi#revoke_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end