class MuxRuby::URLSigningKeysApi
Attributes
Public Class Methods
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a URL signing key Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. @param [Hash] opts the optional parameters @return [SigningKeyResponse]
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 26 def create_url_signing_key(opts = {}) data, _status_code, _headers = create_url_signing_key_with_http_info(opts) data end
Create a URL signing key Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. @param [Hash] opts the optional parameters @return [Array<(SigningKeyResponse
, Integer, Hash)>] SigningKeyResponse
data, response status code and response headers
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 35 def create_url_signing_key_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.create_url_signing_key ...' end # resource path local_var_path = '/video/v1/signing-keys' # 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] || 'SigningKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"URLSigningKeysApi.create_url_signing_key", :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: URLSigningKeysApi#create_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a URL signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. @param signing_key_id [String] The ID of the signing key. @param [Hash] opts the optional parameters @return [nil]
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 84 def delete_url_signing_key(signing_key_id, opts = {}) delete_url_signing_key_with_http_info(signing_key_id, opts) nil end
Delete a URL signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. @param signing_key_id [String] The ID of the signing key. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 94 def delete_url_signing_key_with_http_info(signing_key_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.delete_url_signing_key ...' end # verify the required parameter 'signing_key_id' is set if @api_client.config.client_side_validation && signing_key_id.nil? fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling URLSigningKeysApi.delete_url_signing_key" end # resource path local_var_path = '/video/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', CGI.escape(signing_key_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"URLSigningKeysApi.delete_url_signing_key", :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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: URLSigningKeysApi#delete_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieve a URL signing key Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** @param signing_key_id [String] The ID of the signing key. @param [Hash] opts the optional parameters @return [SigningKeyResponse]
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 145 def get_url_signing_key(signing_key_id, opts = {}) data, _status_code, _headers = get_url_signing_key_with_http_info(signing_key_id, opts) data end
Retrieve a URL signing key Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** @param signing_key_id [String] The ID of the signing key. @param [Hash] opts the optional parameters @return [Array<(SigningKeyResponse
, Integer, Hash)>] SigningKeyResponse
data, response status code and response headers
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 155 def get_url_signing_key_with_http_info(signing_key_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.get_url_signing_key ...' end # verify the required parameter 'signing_key_id' is set if @api_client.config.client_side_validation && signing_key_id.nil? fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling URLSigningKeysApi.get_url_signing_key" end # resource path local_var_path = '/video/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', CGI.escape(signing_key_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] || 'SigningKeyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"URLSigningKeysApi.get_url_signing_key", :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: URLSigningKeysApi#get_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List URL signing keys Returns a list of URL signing keys. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of items to include in the response (default to 25) @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1) @return [ListSigningKeysResponse]
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 209 def list_url_signing_keys(opts = {}) data, _status_code, _headers = list_url_signing_keys_with_http_info(opts) data end
List URL signing keys Returns a list of URL signing keys. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of items to include in the response @option opts [Integer] :page Offset by this many pages, of the size of `limit` @return [Array<(ListSigningKeysResponse
, Integer, Hash)>] ListSigningKeysResponse
data, response status code and response headers
# File lib/mux_ruby/api/url_signing_keys_api.rb, line 220 def list_url_signing_keys_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.list_url_signing_keys ...' end # resource path local_var_path = '/video/v1/signing-keys' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'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] || 'ListSigningKeysResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"URLSigningKeysApi.list_url_signing_keys", :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: URLSigningKeysApi#list_url_signing_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end