Class: Falcon::InstallationTokensApi
- Inherits:
-
Object
- Object
- Falcon::InstallationTokensApi
- Defined in:
- lib/crimson-falcon/api/installation_tokens_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#audit_events_query(opts = {}) ⇒ MsaspecQueryResponse
Search for audit events by providing an FQL filter and paging details.
-
#audit_events_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Search for audit events by providing an FQL filter and paging details.
-
#audit_events_read(opts = {}) ⇒ ApiAuditEventDetailsResponseV1
Gets the details of one or more audit events by id.
-
#audit_events_read_with_http_info(opts = {}) ⇒ Array<(ApiAuditEventDetailsResponseV1, Integer, Hash)>
Gets the details of one or more audit events by id.
-
#customer_settings_read(opts = {}) ⇒ ApiCustomerSettingsResponseV1
Check current installation token settings.
-
#customer_settings_read_with_http_info(opts = {}) ⇒ Array<(ApiCustomerSettingsResponseV1, Integer, Hash)>
Check current installation token settings.
-
#initialize(api_client = ApiClient.default) ⇒ InstallationTokensApi
constructor
A new instance of InstallationTokensApi.
-
#tokens_create(body, opts = {}) ⇒ ApiTokenDetailsResponseV1
Creates a token.
-
#tokens_create_with_http_info(body, opts = {}) ⇒ Array<(ApiTokenDetailsResponseV1, Integer, Hash)>
Creates a token.
-
#tokens_delete(ids, opts = {}) ⇒ MsaspecResponseFields
Deletes a token immediately.
-
#tokens_delete_with_http_info(ids, opts = {}) ⇒ Array<(MsaspecResponseFields, Integer, Hash)>
Deletes a token immediately.
-
#tokens_query(opts = {}) ⇒ MsaspecQueryResponse
Search for tokens by providing an FQL filter and paging details.
-
#tokens_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Search for tokens by providing an FQL filter and paging details.
-
#tokens_read(opts = {}) ⇒ ApiTokenDetailsResponseV1
Gets the details of one or more tokens by id.
-
#tokens_read_with_http_info(opts = {}) ⇒ Array<(ApiTokenDetailsResponseV1, Integer, Hash)>
Gets the details of one or more tokens by id.
-
#tokens_update(ids, body, opts = {}) ⇒ MsaspecQueryResponse
Updates one or more tokens.
-
#tokens_update_with_http_info(ids, body, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Updates one or more tokens.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ InstallationTokensApi
Returns a new instance of InstallationTokensApi.
36 37 38 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 36 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
34 35 36 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 34 def api_client @api_client end |
Instance Method Details
#audit_events_query(opts = {}) ⇒ MsaspecQueryResponse
Search for audit events by providing an FQL filter and paging details.
46 47 48 49 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 46 def audit_events_query(opts = {}) data, _status_code, _headers = audit_events_query_with_http_info(opts) data end |
#audit_events_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Search for audit events by providing an FQL filter and paging details.
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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 58 def audit_events_query_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.audit_events_query ...' end # resource path local_var_path = '/installation-tokens/queries/audit-events/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'MsaspecQueryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.audit_events_query", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#audit_events_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#audit_events_read(opts = {}) ⇒ ApiAuditEventDetailsResponseV1
Gets the details of one or more audit events by id.
110 111 112 113 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 110 def audit_events_read(opts = {}) data, _status_code, _headers = audit_events_read_with_http_info(opts) data end |
#audit_events_read_with_http_info(opts = {}) ⇒ Array<(ApiAuditEventDetailsResponseV1, Integer, Hash)>
Gets the details of one or more audit events by id.
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 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 119 def audit_events_read_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.audit_events_read ...' end # resource path local_var_path = '/installation-tokens/entities/audit-events/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].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] || 'ApiAuditEventDetailsResponseV1' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.audit_events_read", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#audit_events_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#customer_settings_read(opts = {}) ⇒ ApiCustomerSettingsResponseV1
Check current installation token settings.
167 168 169 170 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 167 def customer_settings_read(opts = {}) data, _status_code, _headers = customer_settings_read_with_http_info(opts) data end |
#customer_settings_read_with_http_info(opts = {}) ⇒ Array<(ApiCustomerSettingsResponseV1, Integer, Hash)>
Check current installation token settings.
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 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 175 def customer_settings_read_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.customer_settings_read ...' end # resource path local_var_path = '/installation-tokens/entities/customer-settings/v1' # 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] || 'ApiCustomerSettingsResponseV1' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.customer_settings_read", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#customer_settings_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tokens_create(body, opts = {}) ⇒ ApiTokenDetailsResponseV1
Creates a token.
223 224 225 226 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 223 def tokens_create(body, opts = {}) data, _status_code, _headers = tokens_create_with_http_info(body, opts) data end |
#tokens_create_with_http_info(body, opts = {}) ⇒ Array<(ApiTokenDetailsResponseV1, Integer, Hash)>
Creates a token.
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 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 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 232 def tokens_create_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.tokens_create ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling InstallationTokensApi.tokens_create" end # resource path local_var_path = '/installation-tokens/entities/tokens/v1' # 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(body) # return_type return_type = opts[:debug_return_type] || 'ApiTokenDetailsResponseV1' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.tokens_create", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#tokens_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tokens_delete(ids, opts = {}) ⇒ MsaspecResponseFields
Deletes a token immediately. To revoke a token, use PATCH /installation-tokens/entities/tokens/v1 instead.
289 290 291 292 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 289 def tokens_delete(ids, opts = {}) data, _status_code, _headers = tokens_delete_with_http_info(ids, opts) data end |
#tokens_delete_with_http_info(ids, opts = {}) ⇒ Array<(MsaspecResponseFields, Integer, Hash)>
Deletes a token immediately. To revoke a token, use PATCH /installation-tokens/entities/tokens/v1 instead.
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 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 298 def tokens_delete_with_http_info(ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.tokens_delete ...' end # verify the required parameter 'ids' is set if @api_client.config.client_side_validation && ids.nil? fail ArgumentError, "Missing the required parameter 'ids' when calling InstallationTokensApi.tokens_delete" end # resource path local_var_path = '/installation-tokens/entities/tokens/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'ids'] = @api_client.build_collection_param(ids, :csv) # 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] || 'MsaspecResponseFields' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.tokens_delete", :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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#tokens_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tokens_query(opts = {}) ⇒ MsaspecQueryResponse
Search for tokens by providing an FQL filter and paging details.
354 355 356 357 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 354 def tokens_query(opts = {}) data, _status_code, _headers = tokens_query_with_http_info(opts) data end |
#tokens_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Search for tokens by providing an FQL filter and paging details.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 366 def tokens_query_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.tokens_query ...' end # resource path local_var_path = '/installation-tokens/queries/tokens/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'MsaspecQueryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.tokens_query", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#tokens_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tokens_read(opts = {}) ⇒ ApiTokenDetailsResponseV1
Gets the details of one or more tokens by id.
418 419 420 421 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 418 def tokens_read(opts = {}) data, _status_code, _headers = tokens_read_with_http_info(opts) data end |
#tokens_read_with_http_info(opts = {}) ⇒ Array<(ApiTokenDetailsResponseV1, Integer, Hash)>
Gets the details of one or more tokens by id.
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 427 def tokens_read_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.tokens_read ...' end # resource path local_var_path = '/installation-tokens/entities/tokens/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].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] || 'ApiTokenDetailsResponseV1' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.tokens_read", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#tokens_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tokens_update(ids, body, opts = {}) ⇒ MsaspecQueryResponse
Updates one or more tokens. Use this endpoint to edit labels, change expiration, revoke, or restore.
477 478 479 480 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 477 def tokens_update(ids, body, opts = {}) data, _status_code, _headers = tokens_update_with_http_info(ids, body, opts) data end |
#tokens_update_with_http_info(ids, body, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>
Updates one or more tokens. Use this endpoint to edit labels, change expiration, revoke, or restore.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
# File 'lib/crimson-falcon/api/installation_tokens_api.rb', line 487 def tokens_update_with_http_info(ids, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InstallationTokensApi.tokens_update ...' end # verify the required parameter 'ids' is set if @api_client.config.client_side_validation && ids.nil? fail ArgumentError, "Missing the required parameter 'ids' when calling InstallationTokensApi.tokens_update" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling InstallationTokensApi.tokens_update" end # resource path local_var_path = '/installation-tokens/entities/tokens/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'ids'] = @api_client.build_collection_param(ids, :csv) # 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(body) # return_type return_type = opts[:debug_return_type] || 'MsaspecQueryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"InstallationTokensApi.tokens_update", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InstallationTokensApi#tokens_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |