Class: NgrokAPI::Services::CertificateAuthoritiesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::CertificateAuthoritiesClient
- Defined in:
- lib/ngrokapi/services/certificate_authorities_client.rb
Overview
Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
Constant Summary collapse
- PATH =
The API path for the requests
'/certificate_authorities'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'certificate_authorities'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority
Upload a new Certificate Authority.
-
#create!(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority
Upload a new Certificate Authority Throws an exception if API error.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Certificate Authority.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Certificate Authority Throws an exception if API error.
-
#get(id: "") ⇒ NgrokAPI::Models::CertificateAuthority
Get detailed information about a certficate authority.
-
#get!(id: "") ⇒ NgrokAPI::Models::CertificateAuthority
Get detailed information about a certficate authority Throws an exception if API error.
-
#initialize(client:) ⇒ CertificateAuthoritiesClient
constructor
A new instance of CertificateAuthoritiesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Certificate Authority on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Certificate Authority on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority
Update attributes of a Certificate Authority by ID.
-
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority
Update attributes of a Certificate Authority by ID Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ CertificateAuthoritiesClient
Returns a new instance of CertificateAuthoritiesClient.
21 22 23 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 21 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
19 20 21 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 19 def client @client end |
Instance Method Details
#create(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority
Upload a new Certificate Authority
https://ngrok.com/docs/api#api-certificate-authorities-create
34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 34 def create(description: "", metadata: "", ca_pem:) path = '/certificate_authorities' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:ca_pem] = ca_pem if ca_pem result = @client.post(path % replacements, data: data) NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority
Upload a new Certificate Authority Throws an exception if API error.
https://ngrok.com/docs/api#api-certificate-authorities-create
56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 56 def create!(description: "", metadata: "", ca_pem:) path = '/certificate_authorities' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:ca_pem] = ca_pem if ca_pem result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Certificate Authority
https://ngrok.com/docs/api#api-certificate-authorities-delete
75 76 77 78 79 80 81 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 75 def delete(id: "") path = '/certificate_authorities/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a Certificate Authority Throws an exception if API error.
https://ngrok.com/docs/api#api-certificate-authorities-delete
91 92 93 94 95 96 97 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 91 def delete!(id: "") path = '/certificate_authorities/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::CertificateAuthority
Get detailed information about a certficate authority
106 107 108 109 110 111 112 113 114 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 106 def get(id: "") path = '/certificate_authorities/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::CertificateAuthority
Get detailed information about a certficate authority Throws an exception if API error.
124 125 126 127 128 129 130 131 132 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 124 def get!(id: "") path = '/certificate_authorities/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Certificate Authority on this account
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 143 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::CertificateAuthority ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all Certificate Authority on this account Throws an exception if API error.
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 169 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::CertificateAuthority, danger: true ) end |
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority
Update attributes of a Certificate Authority by ID
https://ngrok.com/docs/api#api-certificate-authorities-update
196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 196 def update(id: "", description: nil, metadata: nil) path = '/certificate_authorities/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data) NgrokAPI::Models::CertificateAuthority.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority
Update attributes of a Certificate Authority by ID Throws an exception if API error.
https://ngrok.com/docs/api#api-certificate-authorities-update
218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 218 def update!(id: "", description: nil, metadata: nil) path = '/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::CertificateAuthority.new(client: self, attrs: result) end |