Class: MuxRuby::SigningKeysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/signing_keys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SigningKeysApi

Returns a new instance of SigningKeysApi.



19
20
21
 
# File 'lib/mux_ruby/api/signing_keys_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/mux_ruby/api/signing_keys_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_signing_key(opts = {}) ⇒ SigningKeyResponse

Create a 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.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 26

def create_signing_key(opts = {})
  data, _status_code, _headers = create_signing_key_with_http_info(opts)
  data
end

#create_signing_key_with_http_info(opts = {}) ⇒ Array<(SigningKeyResponse, Integer, Hash)>

Create a 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.

Parameters:

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

    the optional parameters

Returns:

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

    SigningKeyResponse data, response status code and response headers



35
36
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
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 35

def create_signing_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SigningKeysApi.create_signing_key ...'
  end
  # resource path
  local_var_path = '/system/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 => :"SigningKeysApi.create_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: SigningKeysApi#create_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_signing_key(signing_key_id, opts = {}) ⇒ nil

Delete a signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.

Parameters:

  • signing_key_id (String) —

    The ID of the signing key.

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

    the optional parameters

Returns:

  • (nil) 


84
85
86
87
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 84

def delete_signing_key(signing_key_id, opts = {})
  delete_signing_key_with_http_info(signing_key_id, opts)
  nil
end

#delete_signing_key_with_http_info(signing_key_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.

Parameters:

  • signing_key_id (String) —

    The ID of the signing key.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
134
135
136
137
138
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 94

def delete_signing_key_with_http_info(signing_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SigningKeysApi.delete_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 SigningKeysApi.delete_signing_key"
  end
  # resource path
  local_var_path = '/system/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 => :"SigningKeysApi.delete_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: SigningKeysApi#delete_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_signing_key(signing_key_id, opts = {}) ⇒ SigningKeyResponse

Retrieve a signing key Retrieves the details of a 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.**

Parameters:

  • signing_key_id (String) —

    The ID of the signing key.

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 145

def get_signing_key(signing_key_id, opts = {})
  data, _status_code, _headers = get_signing_key_with_http_info(signing_key_id, opts)
  data
end

#get_signing_key_with_http_info(signing_key_id, opts = {}) ⇒ Array<(SigningKeyResponse, Integer, Hash)>

Retrieve a signing key Retrieves the details of a 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.**

Parameters:

  • signing_key_id (String) —

    The ID of the signing key.

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

    the optional parameters

Returns:

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

    SigningKeyResponse data, response status code and response headers



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 155

def get_signing_key_with_http_info(signing_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SigningKeysApi.get_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 SigningKeysApi.get_signing_key"
  end
  # resource path
  local_var_path = '/system/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 => :"SigningKeysApi.get_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: SigningKeysApi#get_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_signing_keys(opts = {}) ⇒ ListSigningKeysResponse

List signing keys Returns a list of signing keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response (default to 25)

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

Returns:



209
210
211
212
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 209

def list_signing_keys(opts = {})
  data, _status_code, _headers = list_signing_keys_with_http_info(opts)
  data
end

#list_signing_keys_with_http_info(opts = {}) ⇒ Array<(ListSigningKeysResponse, Integer, Hash)>

List signing keys Returns a list of signing keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

Returns:

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

    ListSigningKeysResponse data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/mux_ruby/api/signing_keys_api.rb', line 220

def list_signing_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SigningKeysApi.list_signing_keys ...'
  end
  # resource path
  local_var_path = '/system/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 => :"SigningKeysApi.list_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: SigningKeysApi#list_signing_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end