Class: NgrokAPI::Services::SSHCertificateAuthoritiesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::SSHCertificateAuthoritiesClient
- 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.
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
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0) ⇒ NgrokAPI::Models::SSHCertificateAuthority
Create a new SSH Certificate Authority.
-
#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.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH Certificate Authority.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH Certificate Authority Throws an exception if API error.
-
#get(id: "") ⇒ NgrokAPI::Models::SSHCertificateAuthority
Get detailed information about an SSH Certficate Authority.
-
#get!(id: "") ⇒ NgrokAPI::Models::SSHCertificateAuthority
Get detailed information about an SSH Certficate Authority Throws an exception if API error.
-
#initialize(client:) ⇒ SSHCertificateAuthoritiesClient
constructor
A new instance of SSHCertificateAuthoritiesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all SSH Certificate Authorities on this account.
-
#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.
-
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHCertificateAuthority
Update an SSH Certificate Authority.
-
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHCertificateAuthority
Update an SSH Certificate Authority Throws an exception if API error.
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
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] = if 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.
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] = if 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
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.
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
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.
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
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# 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.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 180 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
211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 211 def update(id: "", description: nil, metadata: nil) path = '/ssh_certificate_authorities/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if 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.
233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 233 def update!(id: "", description: nil, metadata: nil) path = '/ssh_certificate_authorities/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result) end |