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.
18 19 20 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 18 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
16 17 18 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 16 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
33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 33 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.
59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 59 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
80 81 82 83 84 85 86 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 80 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.
96 97 98 99 100 101 102 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 96 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
111 112 113 114 115 116 117 118 119 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 111 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.
129 130 131 132 133 134 135 136 137 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 129 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
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 148 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.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 174 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
201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 201 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.
223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 223 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 |