Class: NgrokAPI::Services::SSHCertificateAuthoritiesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/ssh_certificate_authorities_client.rb

Overview

An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

https://ngrok.com/docs/api#api-ssh-certificate-authorities

Constant Summary collapse

PATH =

The API path for the requests

'/ssh_certificate_authorities'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'ssh_certificate_authorities'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SSHCertificateAuthoritiesClient

Returns a new instance of SSHCertificateAuthoritiesClient.



20
21
22
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 20

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



18
19
20
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 18

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0) ⇒ NgrokAPI::Models::SSHCertificateAuthority

Create a new SSH Certificate Authority

https://ngrok.com/docs/api#api-ssh-certificate-authorities-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

  • private_key_type (string) (defaults to: "") —

    the type of private key to generate. one of rsa, ecdsa, ed25519

  • elliptic_curve (string) (defaults to: "") —

    the type of elliptic curve to use when creating an ECDSA key

  • key_size (int64) (defaults to: 0) —

    the key size to use when creating an RSA key. one of 2048 or 4096

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 35

def create(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0)
  path = '/ssh_certificate_authorities'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:private_key_type] = private_key_type if private_key_type
  data[:elliptic_curve] = elliptic_curve if elliptic_curve
  data[:key_size] = key_size if key_size
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0) ⇒ NgrokAPI::Models::SSHCertificateAuthority

Create a new SSH Certificate Authority Throws an exception if API error.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

  • private_key_type (string) (defaults to: "") —

    the type of private key to generate. one of rsa, ecdsa, ed25519

  • elliptic_curve (string) (defaults to: "") —

    the type of elliptic curve to use when creating an ECDSA key

  • key_size (int64) (defaults to: 0) —

    the key size to use when creating an RSA key. one of 2048 or 4096

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 61

def create!(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0)
  path = '/ssh_certificate_authorities'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:private_key_type] = private_key_type if private_key_type
  data[:elliptic_curve] = elliptic_curve if elliptic_curve
  data[:key_size] = key_size if key_size
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an SSH Certificate Authority

https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



82
83
84
85
86
87
88
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 82

def delete(id: "")
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an SSH Certificate Authority Throws an exception if API error.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



98
99
100
101
102
103
104
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 98

def delete!(id: "")
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::SSHCertificateAuthority

Get detailed information about an SSH Certficate Authority

https://ngrok.com/docs/api#api-ssh-certificate-authorities-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



113
114
115
116
117
118
119
120
121
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 113

def get(id: "")
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::SSHCertificateAuthority

Get detailed information about an SSH Certficate Authority Throws an exception if API error.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



131
132
133
134
135
136
137
138
139
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 131

def get!(id: "")
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all SSH Certificate Authorities on this account

https://ngrok.com/docs/api#api-ssh-certificate-authorities-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 150

def list(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::SSHCertificateAuthority
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all SSH Certificate Authorities on this account Throws an exception if API error.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 176

def list!(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::SSHCertificateAuthority,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHCertificateAuthority

Update an SSH Certificate Authority

https://ngrok.com/docs/api#api-ssh-certificate-authorities-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

Returns:



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 203

def update(id: "", description: nil, metadata: nil)
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end

#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHCertificateAuthority

Update an SSH Certificate Authority Throws an exception if API error.

https://ngrok.com/docs/api#api-ssh-certificate-authorities-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of this SSH Certificate Authority. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.

Returns:



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 225

def update!(id: "", description: nil, metadata: nil)
  path = '/ssh_certificate_authorities/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
end