Class: NgrokAPI::Services::SSHUserCertificatesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::SSHUserCertificatesClient
- Defined in:
- lib/ngrokapi/services/ssh_user_certificates_client.rb
Overview
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.
Constant Summary collapse
- PATH =
The API path for the requests
'/ssh_user_certificates'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'ssh_user_certificates'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Create a new SSH User Certificate.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH User Certificate.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH User Certificate Throws an exception if API error.
-
#get(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Get detailed information about an SSH User Certficate.
-
#get!(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Get detailed information about an SSH User Certficate Throws an exception if API error.
-
#initialize(client:) ⇒ SSHUserCertificatesClient
constructor
A new instance of SSHUserCertificatesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all SSH User Certificates issued on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all SSH User Certificates issued on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate
Update an SSH User Certificate.
-
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate
Update an SSH User Certificate Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ SSHUserCertificatesClient
Returns a new instance of SSHUserCertificatesClient.
19 20 21 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 19 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
17 18 19 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 17 def client @client end |
Instance Method Details
#create(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Create a new SSH User Certificate
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 38 def create(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "") path = '/ssh_user_certificates' replacements = { } data = {} data[:ssh_certificate_authority_id] = if data[:public_key] = public_key if public_key data[:principals] = principals if principals data[:critical_options] = if data[:extensions] = extensions if extensions data[:valid_after] = valid_after if valid_after data[:valid_until] = valid_until if valid_until data[:description] = description if description data[:metadata] = if result = @client.post(path % replacements, data: data) NgrokAPI::Models::SSHUserCertificate.new(client: self, result: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH User Certificate
63 64 65 66 67 68 69 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 63 def delete(id: "") path = '/ssh_user_certificates/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an SSH User Certificate Throws an exception if API error.
79 80 81 82 83 84 85 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 79 def delete!(id: "") path = '/ssh_user_certificates/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Get detailed information about an SSH User Certficate
94 95 96 97 98 99 100 101 102 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 94 def get(id: "") path = '/ssh_user_certificates/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::SSHUserCertificate.new(client: self, result: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate
Get detailed information about an SSH User Certficate Throws an exception if API error.
112 113 114 115 116 117 118 119 120 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 112 def get!(id: "") path = '/ssh_user_certificates/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHUserCertificate.new(client: self, result: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all SSH User Certificates issued on this account
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 131 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, result: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::SSHUserCertificate ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all SSH User Certificates issued on this account Throws an exception if API error.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 158 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, result: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::SSHUserCertificate, danger: true ) end |
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate
Update an SSH User Certificate
186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 186 def update(id: "", description: nil, metadata: nil) path = '/ssh_user_certificates/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data) NgrokAPI::Models::SSHUserCertificate.new(client: self, result: result) end |
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate
Update an SSH User Certificate Throws an exception if API error.
208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 208 def update!(id: "", description: nil, metadata: nil) path = '/ssh_user_certificates/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHUserCertificate.new(client: self, result: result) end |